MCP Tools Reference

The main context retrieval tool. Use it first for project documents, parsed business files, and current-truth source material. Returns the most relevant sections within your token budget.

Parameters

Response Format

{
  "answer_pack": {
    "version": "source_answer_pack_v1",
    "query_intent": "security",
    "source_facts": [
      {
        "claim": "API keys are accepted through X-API-Key or Authorization: Bearer.",
        "source": {
          "title": "Authentication Flow",
          "file": "docs/auth.md",
          "lines": [45, 120],
          "relevance_score": 0.94,
          "quality_score": 0.88
        }
      }
    ],
    "caveats": [],
    "verification_checklist": ["Answer from source_facts first"]
  },
  "sections": [
    {
      "title": "Authentication Flow",
      "content": "...",
      "file": "docs/auth.md",
      "lines": [45, 120],
      "relevance_score": 0.94,
      "token_count": 1200,
      "quality_score": 0.88,
      "quality_flags": []
    }
  ],
  "answer_pack_included": true,
  "retrieval_diagnostics": {
    "status": "warning",
    "confidence": 0.78,
    "section_count": 1,
    "source_count": 1,
    "weak_source_count": 0,
    "avg_relevance": 0.94,
    "top_relevance": 0.94,
    "recommendations": ["Avoid broad claims from a single source; cite the limitation or retrieve more evidence."]
  },
  "total_tokens": 3800,
  "suggestions": ["Also check: docs/security.md"]
}

Example

// Query example
{
  "query": "How does user authentication work?",
  "max_tokens": 4000,
  "search_mode": "hybrid"
}

Discover the right MCP tool for your task. Get recommendations based on your query, detailed tool info, or browse tools by tier. Perfect for new users or when you're unsure which tool to use.

Parameters

Response Format

{
  "recommendations": [
    {
      "tool": "snipara_multi_project_query",
      "score": 92,
      "tier": "TEAM",
      "description": "Query across all team projects",
      "use_cases": ["Cross-project search", "Find implementations"],
      "example": "snipara_multi_project_query(query='authentication')"
    }
  ],
  "total_tools": 134,
  "tip": "Use tier='PRIMARY' to see essential tools"
}

Example

// Get tool recommendations
snipara_help({ query: "I want to search across all my team projects" })

// Get info about a specific tool
snipara_help({ tool: "snipara_context_query" })

// List all primary tools
snipara_help({ tier: "primary" })

// Deterministically list all tools available to this caller
snipara_help({ list_all: true })

Break a complex query into sub-queries with an execution plan. Your LLM can then call snipara_multi_query to get context for each sub-query.

Parameters

Response Format

{
  "original_query": "Explain the full authentication system",
  "sub_queries": [
    { "id": 1, "query": "How does login flow work?", "priority": 1 },
    { "id": 2, "query": "How are sessions managed?", "priority": 2 }
  ],
  "dependencies": [[1, 2]],
  "suggested_sequence": [1, 2],
  "total_estimated_tokens": 4000,
  "strategy_used": "auto"
}

Execute multiple queries in a single call with per-query token budgets. Efficient for parallel context retrieval.

Parameters

Response Format

{
  "results": [
    {
      "query": "How does login flow work?",
      "sections": [...],
      "tokens_used": 1800,
      "allocated_tokens": 2000,
      "section_count": 3,
      "success": true
    },
    {
      "query": "How are JWT tokens generated?",
      "sections": [...],
      "tokens_used": 1500,
      "allocated_tokens": 2000,
      "section_count": 2,
      "success": true
    }
  ],
  "total_tokens": 3300,
  "queries_executed": 2,
  "queries_skipped": 0,
  "search_mode": "hybrid"
}

Generate a full execution plan for complex questions, including query decomposition, dependencies, and optimal execution order.

Parameters

Response Format

{
  "plan_id": "plan_abc123",
  "query": "implement rate limiting across API routes",
  "steps": [
    {
      "step": 1,
      "action": "decompose",
      "params": { "query": "...", "max_depth": 2 },
      "depends_on": [],
      "expected_output": "sub_queries"
    }
  ],
  "estimated_total_tokens": 16000,
  "strategy": "relevance_first",
  "estimated_queries": 4
}

Query across granted projects in a team with a single call. Returns context from multiple projects ranked by relevance. Requires a service account key.

Parameters

Response Format

{
  "query": "How does authentication work?",
  "projects_queried": 5,
  "projects_skipped": 0,
  "results": [
    {
      "project_slug": "api-service",
      "sections": [...],
      "tokens": 800
    },
    {
      "project_slug": "web-app",
      "sections": [...],
      "tokens": 600
    }
  ],
  "total_tokens": 3200
}

Legacy query tool using keyword search. Use snipara_context_query instead for better results.

Parameters

Response Format

{
  "query": "release notes",
  "sections": [{ "title": "Release notes", "file_path": "docs/releases.md", "lines": [1, 40] }],
  "total_matches": 1,
  "shown": 1,
  "recommendation": "Use snipara_context_query for semantic search with better results"
}

Search documentation using regex patterns. Useful for finding specific function names, configuration keys, or code patterns.

Parameters

Response Format

{
  "matches": [
    {
      "file": "docs/config.md",
      "line": 45,
      "content": "API_KEY=your-key-here",
      "context": "..."
    }
  ],
  "total_matches": 15
}

Inject session context that persists across queries. Useful for setting task-specific focus areas.

Parameters

Response Format

{
  "success": true,
  "context": "Task: Fix authentication bug. Focus: auth.ts, middleware.ts"
}

Show the current session context. Useful for checking what context is active.

Parameters

Response Format

{
  "context": "Task: Fix authentication bug. Focus: auth.ts, middleware.ts",
  "injected_at": "2024-01-15T10:30:00Z"
}

Clear the session context. Use when switching tasks.

Parameters

Response Format

{
  "success": true,
  "message": "Session context cleared"
}

Get statistics about the indexed documentation.

Parameters

Response Format

{
  "total_documents": 42,
  "total_sections": 156,
  "total_tokens": 125000,
  "last_updated": "2024-01-15T10:30:00Z"
}

List all documentation sections. Useful for understanding what topics are covered.

Parameters

Response Format

{
  "sections": [
    { "id": "auth-overview", "title": "Authentication Overview", "file": "docs/auth.md" },
    { "id": "api-keys", "title": "API Keys", "file": "docs/auth.md" }
  ]
}

Read specific line ranges from documentation. Useful after searching to get full context.

Parameters

Response Format

{
  "content": "Full content of lines 100-150...",
  "file": "docs/auth.md",
  "lines": [100, 150]
}

Get project settings from the Snipara dashboard. Returns configuration like auto-inject preferences, default search mode, etc.

Parameters

Response Format

{
  "projectId": "abc123",
  "name": "My Project",
  "defaultSearchMode": "hybrid",
  "autoInjectInstructions": true,
  "maxTokensDefault": 4000
}

Store an LLM-generated summary for a document. Later queries can use stored summaries for faster, more token-efficient responses.

Parameters

Response Format

{
  "summary_id": "sum_abc123",
  "document_path": "docs/auth.md",
  "summary_type": "concise",
  "token_count": 150,
  "created": true,
  "message": "Summary stored successfully"
}

Retrieve stored summaries with optional filters. Use to check what summaries exist or to use them in context.

Parameters

Response Format

{
  "summaries": [
    {
      "summary_id": "sum_abc123",
      "document_path": "docs/auth.md",
      "summary_type": "concise",
      "token_count": 150,
      "content": "Authentication uses JWT tokens...",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "total_count": 1,
  "total_tokens": 150
}

Delete stored summaries by ID, document path, or type.

Parameters

Response Format

{
  "deleted_count": 3,
  "message": "Deleted 3 summaries"
}

Load merged source context from linked shared collections. Use it for standards, business playbooks, and reusable guidance, not for durable memory recall.

Parameters

Response Format

{
  "documents": [
    {
      "id": "doc_123",
      "title": "TypeScript Standards",
      "category": "MANDATORY",
      "token_count": 800,
      "collection_name": "Team Coding Standards",
      "source_type": "LINKED_COLLECTION"
    }
  ],
  "merged_content": "# TypeScript Standards\n...",
  "total_tokens": 2400,
  "collections_loaded": 2,
  "linked_collections_loaded": 2,
  "team_context_documents_loaded": 1,
  "linked_collection_documents_loaded": 3
}

List available prompt templates from linked shared collections. Templates are reusable prompts for common tasks.

Parameters

Response Format

{
  "templates": [
    {
      "id": "tpl_123",
      "name": "Security Review",
      "slug": "security-review",
      "description": "Review code for security issues",
      "category": "review",
      "collection_name": "Team Templates"
    }
  ],
  "total_count": 5,
  "categories": ["review", "refactoring", "testing"]
}

Get a specific prompt template and optionally render it with variable substitution.

Parameters

Response Format

{
  "template": {
    "id": "tpl_123",
    "name": "Security Review",
    "slug": "security-review",
    "prompt": "Review the following code for {{focus_area}}:\n{{code}}",
    "variables": ["focus_area", "code"]
  },
  "rendered_prompt": "Review the following code for SQL injection:\n...",
  "missing_variables": []
}

List all shared context collections accessible to you. Returns collections you own, team collections you're a member of, and public collections. Use this to discover collection IDs for uploading documents.

Parameters

Response Format

{
  "collections": [
    {
      "id": "col_abc123",
      "name": "Team Coding Standards",
      "slug": "team-coding-standards",
      "description": "Shared coding guidelines for all projects",
      "scope": "team",
      "access_type": "team_member",
      "_count": {
        "documents": 12,
        "templates": 5
      }
    },
    {
      "id": "col_def456",
      "name": "Public TypeScript Guide",
      "slug": "public-ts-guide",
      "scope": "public",
      "access_type": "public",
      "_count": {
        "documents": 8,
        "templates": 0
      }
    }
  ],
  "count": 2
}

Example

// List all accessible collections
snipara_list_collections()

// Exclude public collections
snipara_list_collections({ include_public: false })

Upload or update a document in a shared context collection. Use for team best practices, coding standards, and guidelines that should be available across projects.

Parameters

Response Format

{
  "success": true,
  "document_id": "doc_xyz789",
  "collection_id": "col_abc123",
  "title": "Error Handling Standards",
  "category": "BEST_PRACTICES",
  "action": "created"
}

Example

// Upload a new coding standard
snipara_upload_shared_document({
  collection_id: "col_abc123",
  title: "Error Handling Standards",
  content: "# Error Handling\n\nAlways use custom error classes...",
  category: "BEST_PRACTICES",
  priority: 50,
  tags: ["errors", "typescript"]
})

Upload or update a single document. Supports DOC and BINARY parser documents.

Parameters

Response Format

{
  "success": true,
  "document_id": "doc_abc123",
  "path": "docs/getting-started.md",
  "action": "created",
  "token_count": 1500
}

Bulk sync multiple text and binary parser documents in a single call. Efficient for agent, connector, and integrator uploads.

Parameters

Response Format

{
  "success": true,
  "created": 5,
  "updated": 2,
  "deleted": 0,
  "total_documents": 7,
  "total_tokens": 15000
}

Load one exact source document from your Snipara project by path. Use it when you already know the document you need and want direct source truth instead of ranked retrieval or memory recall.

Parameters

Response Format

{
  "path": "docs/api.md",
  "content": "# API Reference\n...",
  "token_count": 3200
}

Load a token-budgeted map of project documents. Use paths_filter to limit the returned files and include_content=false for metadata only.

Parameters

Response Format

{
  "total_files": 15,
  "returned_files": 8,
  "total_tokens": 7500,
  "max_tokens": 16000,
  "documents": [{ "path": "docs/api.md", "token_count": 1200, "lines": 180 }]
}

Run a three-round context exploration: section scan, ranked search, then raw loading of the highest-scoring documents.

Parameters

Response Format

{
  "query": "Analyze authentication flow",
  "timing": { "sections_scan_ms": 2, "ranked_search_ms": 18, "raw_load_ms": 3 },
  "metrics": { "sections_scanned": 42, "files_loaded": 3, "tokens_used": 12400 },
  "rounds": { "sections_scan": {...}, "ranked_search": {...}, "raw_load": {...} }
}

Package project documents as context_data plus optional Python helper code for injection into a Snipara Sandbox REPL session. This tool does not mutate REPL state itself.

Parameters

Response Format

{
  "context_data": { "files": {...}, "sections": [...], "loaded_files": 3 },
  "setup_code": "# Python helper functions...",
  "total_tokens": 2800,
  "usage_hint": "Inject context_data, then execute setup_code"
}

Recipe 1: Debug an Auth Flow

Find and understand authentication issues in your codebase.

// Step 1: Find auth-related code
snipara_search({ pattern: "authenticate|login|session|jwt" })

// Step 2: Get detailed context on the auth system
snipara_context_query({
  query: "authentication flow and session management",
  max_tokens: 6000,
  search_mode: "hybrid"
})

// Step 3: Check team security standards
snipara_shared_context({ categories: ["MANDATORY", "BEST_PRACTICES"] })

Recipe 2: Generate Feature with Repo Context

Break down a complex feature and get relevant context for each part.

// Step 1: Break down the task into subtasks
snipara_decompose({
  query: "implement password reset with email verification",
  max_depth: 2,
  hints: ["email delivery", "token expiry"]
})

// Step 2: Get context for each subtask in parallel
snipara_multi_query({
  queries: [
    { query: "email service configuration and templates", max_tokens: 1800 },
    { query: "password hashing and validation", max_tokens: 1800 },
    { query: "reset token generation and expiry", max_tokens: 1800 }
  ],
  max_tokens: 6000
})

// Step 3: Check existing patterns
snipara_shared_context({ categories: ["BEST_PRACTICES"] })

Recipe 3: Onboard a New Developer

Get a quick overview of a codebase for new team members.

// Step 1: Get project statistics
snipara_stats()

// Step 2: List all documentation sections
snipara_sections()

// Step 3: Get high-level summaries of key areas
snipara_get_summaries({
  summary_type: "overview",
  include_content: true
})

// Step 4: Check team coding standards
snipara_shared_context({
  categories: ["MANDATORY", "BEST_PRACTICES", "GUIDELINES"]
})