Search Docs

Search your repository's documentation to find relevant guides, READMEs, and API docs.

Quick Start

"Find documentation about authentication"

"What docs reference the PaymentService class?"

"Show me API documentation for user management"

When to Use

Use this workflow:

When exploring an unfamiliar codebase
Before implementing a feature to understand existing patterns
When updating code and need to find related docs
To discover API guides and tutorials

Search Modes

Mode	Use Case
`semantic`	General search - "find docs about X"
`linked`	Find docs for specific code symbols
`hybrid`	Both - when you have context symbols but also want topic search

Search Docs Workflow

Choose Your Search Mode

Semantic (default): Natural language search

"Find docs about authentication"

Linked: Find docs that reference specific symbols

"Find docs linked to these symbols: sym_abc123, sym_def456"

Hybrid: Both approaches combined

"Find auth docs, also check docs for the authenticateUser function"

Search for Documentation

Ask your agent:

"Search docs for 'API endpoints'"

Uses: noodlbox_search_documents tool

Results are separated into:

semantic_docs - Documents matching your query text
related_docs - Documents linked to code symbols

Review Results

Each result includes:

Title - Document section heading
File path - Location in repository
Preview - Snippet of content

Example:

{
  "semantic_docs": [
    {
      "title": "Authentication Guide",
      "file_path": "docs/auth/README.md",
      "preview": "This guide explains..."
    }
  ]
}

Read or Update

Ask your agent to read the full document:

"Read docs/auth/README.md"

Or update it if needed:

"Update the authentication guide with the new OAuth flow"

Example: Finding API Documentation

Scenario: You need to understand how the user API works before adding a new endpoint.

Search for User API Docs

"Find documentation about user API endpoints"

Results:

docs/api/users.md - User API Reference
README.md - Quick start section on users

Narrow with Code Context

If you know specific functions:

"Find docs that reference getUserById and createUser"

Uses: mode: "linked" with symbol_uids

Read and Learn

"Read the User API Reference"

Now you understand the patterns and can implement your new endpoint consistently.

Example: Finding Docs for Changed Code

Scenario: You modified authentication code and want to check if docs need updating.

Get Changed Symbols

"What's the impact of my changes?"

Uses: noodlbox_detect_impact

Results include affected_documents automatically.

Search Linked Docs

"Find docs linked to the changed symbols"

Uses: mode: "linked" with symbol UIDs from impact detection

Update Stale Docs

Review each flagged document and update as needed.

See Document Sync for the full doc update workflow.

Combining with Code Search

Documentation search complements code search:

Need	Tool
Find code	`noodlbox_query_with_context`
Find docs	`noodlbox_search_documents`
Find both	Ask agent to search both

Example workflow:

"Find how authentication works - show me both the code and documentation"

Your agent will:

Search code with noodlbox_query_with_context
Search docs with noodlbox_search_documents
Combine results for a complete picture

Tools Reference

Purpose	Tool
Semantic doc search	`noodlbox_search_documents` with `mode: "semantic"`
Linked doc search	`noodlbox_search_documents` with `mode: "linked"`
Hybrid search	`noodlbox_search_documents` with `mode: "hybrid"`
Code search	`noodlbox_query_with_context`
Impact + docs	`noodlbox_detect_impact` (includes `affected_documents`)

Document Sync - Update stale documentation
Document Search Tool - Full MCP tool reference
Context Search - Search code, not docs

On this page