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

# Weaverse MCP

> Connect AI tools to Weaverse documentation using the Model Context Protocol for accurate, contextual assistance

# Weaverse MCP

Access Weaverse documentation and knowledge directly through your favorite AI tools with the Weaverse MCP server.

## About MCP Servers

The Model Context Protocol (MCP) is an open protocol that creates standardized connections between AI applications and external services, like documentation. The Weaverse MCP server enables AI assistants like Claude, Cursor, and others to search Weaverse documentation directly, delivering accurate, context-aware assistance for developers working with Weaverse products.

Your MCP server exposes tools for AI applications to search the Weaverse knowledge base and find relevant information, code examples, API references, and implementation guides.

## Accessing the Weaverse MCP Server

The Weaverse MCP server is automatically hosted at:

```
https://docs.weaverse.io/mcp
```

This HTTP-based server is always available and requires no installation or setup. Simply connect your AI tools to this URL to start accessing Weaverse documentation.

<Note>
  The MCP server is publicly available and automatically generated from the Weaverse documentation.
</Note>

## Connecting to AI Tools

Connect the Weaverse MCP server to your preferred AI development tools:

<Tabs>
  <Tab title="Contextual Menu">
    The easiest way to connect is using the contextual menu available on any documentation page:

    1. Click the contextual menu icon (three dots) at the top of any page
    2. Select one of the following options:
       * **Copy MCP server URL** - Copies `https://docs.weaverse.io/mcp` to clipboard
       * **Connect to Cursor** - Automatically installs the MCP server in Cursor
       * **Connect to VS Code** - Automatically installs the MCP server in VS Code

    This one-click integration automatically configures your development environment.
  </Tab>

  <Tab title="Claude Desktop">
    To manually connect to Claude Desktop:

    1. Open Claude Desktop settings
    2. Locate the MCP configuration file:
       * **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
       * **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
    3. Add the Weaverse MCP server configuration:

    ```json theme={null}
    {
      "mcpServers": {
        "weaverse": {
          "url": "https://docs.weaverse.io/mcp"
        }
      }
    }
    ```

    4. Restart Claude Desktop
    5. The Weaverse MCP tools will now be available in your conversations
  </Tab>

  <Tab title="Claude Code">
    Claude Code automatically supports MCP servers through configuration:

    1. Add the server URL to your Claude Code settings
    2. Enter: `https://docs.weaverse.io/mcp`
    3. The Weaverse documentation will be accessible in your coding sessions

    Refer to the [Claude Code MCP guide](https://docs.anthropic.com/en/docs/build-with-claude/mcp) for detailed setup instructions.
  </Tab>

  <Tab title="Cursor">
    To configure Cursor manually:

    1. Open Cursor Settings (⌘/Ctrl + ,)
    2. Navigate to **Extensions** > **MCPs**
    3. Add a new MCP server with:
       * **Name**: `weaverse`
       * **URL**: `https://docs.weaverse.io/mcp`

    Or use the contextual menu "Connect to Cursor" option for automatic setup.
  </Tab>

  <Tab title="VS Code">
    To configure VS Code:

    1. Install an MCP-compatible extension (e.g., Continue, Cody)
    2. Add the Weaverse MCP server in your extension settings:
       * **Server URL**: `https://docs.weaverse.io/mcp`

    Or use the contextual menu "Connect to VS Code" option for automatic setup.
  </Tab>
</Tabs>

## Available Tools

The Weaverse MCP server provides the following tool:

<Card title="SearchWeaverse" icon="magnifying-glass">
  Search across the Weaverse knowledge base to find relevant information, code examples, API references, and implementation guides.

  **Use when you need to**:

  * Answer questions about Weaverse features
  * Find specific documentation or code examples
  * Understand how features work
  * Locate API references and implementation details
  * Troubleshoot issues

  **Returns**: Contextual content with titles and direct links to documentation pages
</Card>

## Common Use Cases

The Weaverse MCP is particularly useful for:

<CardGroup cols={2}>
  <Card title="Component Development" icon="cube">
    Ask about creating custom Weaverse components, schema definitions, and input settings
  </Card>

  <Card title="API Integration" icon="plug">
    Query specific API hooks, component props, and utility functions
  </Card>

  <Card title="Troubleshooting" icon="wrench">
    Share error messages to receive relevant documentation and solutions
  </Card>

  <Card title="Implementation Guidance" icon="map">
    Get step-by-step instructions for implementing Weaverse features
  </Card>
</CardGroup>

### Example Queries

Here are some example questions you can ask your AI assistant with the Weaverse MCP enabled:

```
How do I set up a new Weaverse Hydrogen theme?

What's the difference between 'settings' and 'inspector' in component schemas?

How do I use the createSchema() function?

Show me examples of the useWeaverse hook

What are the available input types for component settings?

How do I implement data fetching in a Weaverse section?

What props does the WeaverseRoot component accept?
```

## How It Works

When you ask a question about Weaverse in your AI tool:

1. **Recognition**: The AI assistant recognizes your question is about Weaverse
2. **Query**: It calls the Weaverse MCP server with your query
3. **Search**: The MCP server searches the Weaverse documentation using the SearchWeaverse tool
4. **Return**: Relevant documentation with links is returned to the AI assistant
5. **Response**: The AI formulates an accurate response based on official documentation

This process ensures responses are accurate and based on the latest Weaverse documentation.

## Benefits

<CardGroup cols={2}>
  <Card title="Always Accurate" icon="check">
    AI assistants access the most up-to-date Weaverse documentation
  </Card>

  <Card title="Context-Aware" icon="brain">
    Get answers tailored to Weaverse's specific implementation and ecosystem
  </Card>

  <Card title="Instant Setup" icon="bolt">
    No installation required - just connect and start using
  </Card>

  <Card title="Seamless Integration" icon="link">
    Works with Claude, Cursor, VS Code, and other MCP-compatible tools
  </Card>
</CardGroup>

## Troubleshooting

<AccordionGroup>
  <Accordion title="MCP server not responding" icon="circle-exclamation">
    * Verify your internet connection
    * Check that the URL is exactly: `https://docs.weaverse.io/mcp`
    * Ensure your AI tool's MCP configuration is correct
    * Try disconnecting and reconnecting the MCP server
  </Accordion>

  <Accordion title="Getting irrelevant results" icon="magnifying-glass">
    * Be specific in your queries
    * Include Weaverse-specific terms (e.g., "createSchema", "WeaverseRoot", "input settings")
    * Mention the specific feature or component you're asking about
    * Try rephrasing your question with more context
  </Accordion>

  <Accordion title="Connection issues" icon="plug">
    * Verify the MCP server URL is correctly configured
    * Restart your AI tool after adding the configuration
    * Check your tool's MCP documentation for setup requirements
    * Ensure your firewall allows connections to docs.weaverse.io
  </Accordion>

  <Accordion title="Tools not showing up" icon="tools">
    * Confirm the MCP server is connected in your tool's settings
    * Restart your AI application
    * Check that your tool supports HTTP-based MCP servers
    * Verify you're using a compatible version of your AI tool
  </Accordion>
</AccordionGroup>

## Next Steps

<CardGroup cols={2}>
  <Card title="Weaverse CLI" icon="terminal" href="/developer-tools/weaverse-cli">
    Learn about the Weaverse CLI for project setup and theme scaffolding
  </Card>

  <Card title="Weaverse SDKs" icon="code" href="/developer-tools/weaverse-sdks">
    Explore the Weaverse SDKs for building custom components
  </Card>

  <Card title="API Reference" icon="book" href="/api-reference/introduction">
    Browse the complete Weaverse API documentation
  </Card>

  <Card title="Development Guide" icon="wrench" href="/development-guide/index">
    Start building with Weaverse Hydrogen themes
  </Card>
</CardGroup>

<Note>
  The Weaverse MCP server is continuously updated as documentation evolves, ensuring your AI tools always have access to the latest information.
</Note>