Document Search

Search your repository's documentation (markdown files, READMEs, guides) to find relevant docs.

Parameters

*Required for semantic and hybrid modes **Required for linked mode, optional for hybrid

Search Modes

Semantic Mode (Default)

Finds documents semantically similar to your query using vector embeddings.

{
  "repository": "owner/my-project",
  "query": "authentication setup guide",
  "mode": "semantic"
}

Linked Mode

Finds documents that reference specific code symbols via DOCUMENTED_BY edges. Requires symbol_uids.

{
  "repository": "owner/my-project",
  "mode": "linked",
  "symbol_uids": ["abc123", "def456"]
}

Use symbol UIDs from noodlbox_query_with_context or noodlbox_detect_impact results.

Hybrid Mode

Combines both semantic and linked search, deduplicating results.

{
  "repository": "owner/my-project",
  "query": "API usage",
  "mode": "hybrid",
  "symbol_uids": ["abc123"]
}

Usage

Ask your agent:

"Find documentation about the authentication system"

"What docs reference the PaymentService class?"

"Show me guides related to my staged changes"

Response

{
  "semantic_docs": [
    {
      "id": "doc_123",
      "title": "Authentication Guide",
      "file_path": "docs/auth/README.md",
      "preview": "This guide explains how to implement..."
    }
  ],
  "related_docs": [
    {
      "id": "doc_456",
      "title": "API Reference",
      "file_path": "docs/api/auth.md",
      "preview": "The authenticateUser function..."
    }
  ],
  "mode": "hybrid"
}

Workflow Example

1. Find changed code with noodlbox_detect_impact
2. Get symbol UIDs from the changed_symbols response
3. Search for related docs using linked or hybrid mode
4. Update docs alongside code changes

Related

• Context Search - Search code, not documentation
• Impact Detection - Find code affected by changes