> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pipecat.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Pipecat Context Hub

> A local index of Pipecat docs, examples, and API source for AI coding tools — available as a CLI and an MCP server.

[Pipecat Context Hub](https://github.com/pipecat-ai/pipecat-context-hub) indexes Pipecat documentation, code examples, and framework API source into a local vector database on your machine. It's built for coding workflows: queries return the actual source and snippets your AI tool needs to write working code, not synthesized prose.

Pipecat's docs, examples, and API surface change often and span several repositories, so a model working from training data goes stale fast. The hub keeps a fresh local index you query directly. You can also point it at your own repositories (public or private) to index private code alongside the framework.

Every tool runs two ways: as a one-shot CLI command and as an MCP server. Use the CLI for a quick lookup. Add the MCP server when a session needs repeated, exploratory queries.

## Setup

The hub is published to PyPI as `pipecat-ai-context-hub` and runs with [`uv`](https://docs.astral.sh/uv/), no clone required. The examples on this page use `uvx`, uv's one-shot runner, which fetches and runs the hub on demand. Build the local index once:

```bash theme={null}
uvx pipecat-ai-context-hub refresh   # build local index (~2 min first run)
```

<Tip>
  To install it once instead of fetching on demand, run `uv tool install
      pipecat-ai-context-hub`. This puts the command on your `PATH`, so you drop the
  `uvx` prefix and call it directly, using the shorter `pipecat-context-hub`
  name.
</Tip>

If the index gets corrupted, you can force a rebuild:

```bash theme={null}
uvx pipecat-ai-context-hub refresh --force
```

If your project targets an older Pipecat version, pin the hub to it so results match what you're running:

```bash theme={null}
uvx pipecat-ai-context-hub refresh --framework-version v0.0.96
```

## Tools

| Tool                | Use it to                                                                                            |
| ------------------- | ---------------------------------------------------------------------------------------------------- |
| `search_docs`       | Find guides and conceptual docs ("how do I ...?")                                                    |
| `search_examples`   | Find working example code by task or component                                                       |
| `search_api`        | Find class definitions, method signatures, frame types, and inheritance                              |
| `get_doc`           | Fetch a full doc page by ID or path                                                                  |
| `get_example`       | Fetch the full source files for an example                                                           |
| `get_code_snippet`  | Fetch targeted code by symbol, intent, or file and line range                                        |
| `check_deprecation` | Check whether an import path is deprecated or removed (can evaluate lifecycle at a specific version) |
| `get_hub_status`    | Report index health, freshness, and the indexed Pipecat version                                      |

The three `search_*` tools return a ranked list of hits, each with a relevance `score`. Each response also carries an evidence report with an overall `confidence`, a `low_confidence` flag, and suggested follow-up queries. The agent triages that list, picks the best fit, then calls a `get_*` tool to pull the full content. The coding agent can pass your `pipecat_version` to score and filter results for compatibility with the version you target. The remaining two tools stand alone: `check_deprecation` reports a symbol's lifecycle, and `get_hub_status` reports index health.

To make your coding agent reach for these tools automatically, add the [recommended CLAUDE.md / AGENTS.md instructions](https://github.com/pipecat-ai/pipecat-context-hub/blob/main/docs/README.md#add-claudemd-instructions-recommended) to your project.

## CLI lookups

Every tool is also a one-shot CLI command, so you can query the index from a shell with no MCP setup. Reach for this when you need a single answer fast, like a deprecation check, an API signature, or an index health check. Each command prints the tool's JSON to stdout:

```bash theme={null}
uvx pipecat-ai-context-hub check-deprecation PipelineTask     # is this symbol deprecated?
uvx pipecat-ai-context-hub search-api "WebsocketServerParams"  # find an API signature
uvx pipecat-ai-context-hub status                              # index health / freshness
```

## MCP server

For a longer build or debugging session where the model probes the index repeatedly, add the hub as an MCP server instead of shelling out per query. It keeps the index warm for the whole session and exposes the same tools to your coding tool directly.

<Tabs>
  <Tab title="Claude Code">
    ```bash theme={null}
    claude mcp add pipecat-context-hub -- uvx pipecat-ai-context-hub serve
    ```
  </Tab>

  <Tab title="Codex">
    ```bash theme={null}
    codex mcp add pipecat-context-hub -- uvx pipecat-ai-context-hub serve
    ```
  </Tab>

  <Tab title="Cursor">
    Add to your Cursor MCP config:

    ```json theme={null}
    {
      "mcpServers": {
        "pipecat-context-hub": {
          "command": "uvx",
          "args": ["pipecat-ai-context-hub", "serve"]
        }
      }
    }
    ```
  </Tab>

  <Tab title="VS Code">
    Add to `.vscode/mcp.json`:

    ```json theme={null}
    {
      "servers": {
        "pipecat-context-hub": {
          "command": "uvx",
          "args": ["pipecat-ai-context-hub", "serve"]
        }
      }
    }
    ```
  </Tab>
</Tabs>

A newly added MCP server loads when your coding tool starts a session, so add it before opening the session you want to use it in.

See the [repo docs](https://github.com/pipecat-ai/pipecat-context-hub) for additional configuration options.

## Next steps

<Card title="Build with a Coding Agent" icon="sparkles" href="/pipecat/get-started/ai-tools">
  The full agent-driven workflow: `pipecat init`, the Context Hub, and your
  first coding session
</Card>