Yavy Logo
Yavy

Documentation

Welcome to Yavy. This guide will help you set up your account, index your projects, and connect your AI agents to your documentation.

1
Registration

Start by creating an account to manage your projects and API keys.

  • Go to Sign Up
  • Enter your details and verify your email
  • Access your dashboard immediately

2
Creating a Project

Add your documentation site to let Yavy index it.

  1. Navigate to the Dashboard
  2. Click New Project
  3. Enter your website URL (e.g., https://docs.example.com)
  4. Yavy will automatically detect your sitemap.xml

3
Sitemaps & Indexing

We use your sitemap to discover all pages.

Discovery

We scan your sitemap to find all public pages automatically.

Indexing

Content is processed and optimized for semantic search.

4
MCP Installation

Connect Yavy to your AI agents using the Model Context Protocol (MCP). Select your agent below for specific instructions.

Claude Code

.mcp.json

Setup Steps

  1. 1
    Create or open the .mcp.json file in your project directory
  2. 2
    Copy the configuration above and paste it into your .mcp.json file
  3. 3
    Restart Claude Code for changes to take effect
  4. 4
    Verify installation by running claude mcp list

Tip: The .mcp.json file in your project directory makes the MCP server available to anyone working on your codebase.

Claude Web (claude.ai)

Setup Custom Connector

  1. 1
    Go to claude.ai and click on your profile icon
  2. 2
    Navigate to Settings > Connectors
  3. 3
    Click Add custom connector
  4. 4
    Fill in the connector details:
    Name:YavyRemote MCP Server URL:https://yavy.dev/mcp/docs
  5. 5
    (Optional) Click Advanced settings to add OAuth Client ID or Client Secret if required
  6. 6
    Click Add to save your connector

Note: Custom connectors are available for Pro, Max, Team, and Enterprise plans only.