# Weaviate Docs MCP Server

:::callout{intent="info" title="Looking for the Weaviate MCP server?"}
This page is about the **Weaviate _Docs_ MCP server** — a hosted server (powered by Kapa.ai) that lets AI assistants query Weaviate's **documentation**.

If you instead want an MCP server that lets AI assistants interact with **your own Weaviate instance** (inspect schemas, run hybrid searches, upsert objects), see the built-in [Weaviate MCP server](configuration-mcp-server.md).
:::

The **Weaviate Docs MCP Server** brings instant access to Weaviate's documentation directly into your AI development environment. Built on the Model Context Protocol (MCP), this server integrates seamlessly with tools like Claude Desktop and Cursor, allowing you to query Weaviate's documentation without leaving your IDE.

The MCP server uses [Kapa.ai](https://kapa.ai) (which in turn uses Weaviate under the hood) as its knowledge engine, which powers the search and retrieval of Weaviate documentation. The server offers:

- **Instant documentation access**: Search Weaviate docs without context switching.
- **Multi-source knowledge base**: Queries across docs, tutorials, API references, GitHub issues and community content.
- **Always up-to-date**: Automatically syncs with the latest Weaviate documentation.

## How to setup MCP Server

:::callout{intent="note" title="MCP server URL"}
**URL**: **https://weaviate-docs.mcp.kapa.ai**
:::

Setup steps vary depending on which AI assistant you're using.

::::tabs{sync="platform"}
:::tab{title="Cursor"}
Add the following to your `.cursor/mcp.json` file:

```json
{
  "mcpServers": {
    "weaviate-docs": {
      "type": "http",
      "url": "https://weaviate-docs.mcp.kapa.ai"
    }
  }
}
```
:::

:::tab{title="VS Code"}
Prerequisites: VS Code 1.102+ with GitHub Copilot enabled.

Create an `mcp.json` file in your workspace `.vscode` folder:

```json
{
  "servers": {
    "weaviate-docs": {
      "type": "http",
      "url": "https://weaviate-docs.mcp.kapa.ai"
    }
  }
}
```
:::

:::tab{title="Claude Code"}
Run the following command in your terminal:

```bash
claude mcp add --transport http weaviate-docs https://weaviate-docs.mcp.kapa.ai
```

Then run the `/mcp` command in Claude Code and follow the steps in your browser to authenticate.

For more information, see the [Claude Code MCP documentation](https://docs.anthropic.com/en/docs/claude-code/mcp).
:::

:::tab{title="ChatGPT Desktop"}
ChatGPT Desktop supports MCP servers in developer mode:

1. Open ChatGPT Desktop.
2. Go to **Settings** > **Apps** > **Advanced settings**.
3. Enable **Developer mode**.
4. Navigate to **Settings** > **Connectors**.
5. Click **Create** and enter:

- **Name**: Weaviate Docs
- **URL**: https://weaviate-docs.mcp.kapa.ai

For more information, see the [ChatGPT Desktop MCP documentation](https://platform.openai.com/docs/guides/developer-mode).
:::

:::tab{title="Claude Desktop"}
Claude Desktop supports MCP servers:

1. Open Claude Desktop.
2. Go to **Settings** > **Connectors**.
3. Click **Add custom connector** and enter:

- **Name**: Weaviate Docs
- **URL**: https://weaviate-docs.mcp.kapa.ai

4. Click on **Connect** and follow the steps in your browser to authenticate.

Restart Claude Desktop for changes to take effect.

For more details, see the [Claude Desktop documentation](https://support.claude.com/en/articles/11175166-getting-started-with-custom-connectors-using-remote-mcp).
:::

:::tab{title="Other"}
MCP is an open protocol supported by many clients. Use the server URL https://weaviate-docs.mcp.kapa.ai and refer to your client's documentation for setup instructions.

Most clients accept the standard MCP JSON configuration format:

```json
{
  "mcpServers": {
    "weaviate-docs": {
      "url": "https://weaviate-docs.mcp.kapa.ai"
    }
  }
}
```
:::
::::

## Using the MCP Server

Once configured, you can ask context-aware questions about Weaviate from within your editor. For example:

```
"How do I set up a hybrid search in Weaviate?"

"What are the best practices for schema design in Weaviate?"

"Search the Weaviate docs for information about BM25 algorithm"

"What's the difference between vector and keyword search in Weaviate?"
```

## Troubleshooting

:::accordion{title="Server not showing up"}
- Check that the file path is correct for your OS
- Restart the app completely
- Ensure the URL is entered correctly
- Verify the config file syntax is valid JSON
:::

:::accordion{title="Connection errors"}
If you see connection errors:

1. Verify the server URL is accessible:

   ```bash
   curl https://weaviate-docs.mcp.kapa.ai
   ```

2. Check your internet connection

3. Try the MCP Inspector to debug:
   ```bash
   npx @modelcontextprotocol/inspector
   ```
:::

:::accordion{title="No results returned"}
If queries return empty results:

- Check that your question is relevant to Weaviate documentation
- Try rephrasing your query
- Verify the MCP server is properly configured (test with curl)
:::

:::accordion{title="Rate limiting"}
The public Weaviate MCP server may have rate limits. If you experience issues:

- Wait a few minutes before trying again
:::

## Further resources

- [Vibe coding - Best practices](index.md)
- [MCP documentation](https://modelcontextprotocol.io)
- [kapa.ai documentation](https://docs.kapa.ai)

## Questions and feedback

Have a question or feedback? Here's how to reach us.

::::card-grid
:::card{title="Community Forum" href="https://forum.weaviate.io/c/support" icon="messages-square"}
Ask questions and connect with other developers on our **Community forum**.
:::

:::card{title="Support" href="/guides/support-overview" icon="life-buoy"}
Weaviate Cloud user or customer? Find the right channel on the **Support page**.
:::
::::

## Related pages

- [Agents](./agents-index.md)
- [AI-assisted Weaviate code generation](./ai-assisted-vibe-coding-index.md)
- [APIs](./apis-index.md)
- [Authorization and authentication](./authorization-and-authentication-index.md)
- [Benchmarks](./benchmarks-index.md)
- [Best practices](./best-practices-index.md)
- [Client libraries](./clients-index.md)
- [Client Libraries / SDKs](./client-libraries-index.md)
- [Cloud](./cloud-index.md)
- [Cloud account management](./cloud-account-management-index.md)

# Agent Instructions

This portal answers questions programmatically. To receive a synthesized,
source-cited answer instead of crawling page by page, append the `?ask=`
query parameter to any page URL on this site:

    /guides/quickstart?ask=how+do+I+authenticate

Optional parameters:

- `&goal=<what-you-are-trying-to-do>` steers the answer toward your
  objective (e.g. `&goal=write+a+python+client`).
- `&version=<label>` scopes the answer to a mounted version when the
  portal publishes more than one.

The response is `text/markdown`: the answer followed by a `# Sources` list
of the portal pages it was grounded in. Status codes are the contract:

- `200` — the answer; `402` — the portal owner’s plan or answer credits are
  exhausted (surface this to your operator; do NOT retry); `429` — you are
  rate-limited; back off for the `Retry-After` seconds; `503` — the answer
  lane is temporarily unavailable; fall back to crawling the `.md` pages.

For the full corpus map read `llms.txt` at the site root; for the tool
surface (search + page fetch as MCP tools) see `/mcp`.
