Documentation

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

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 website to let Yavy index it.

Navigate to the Dashboard
Click New Project
Enter your website URL (e.g., https://docs.example.com)
Yavy will automatically discover and index your web pages

3
URL Discovery & Indexing

We automatically discover and index all your web pages.

Discovery

We automatically find all public pages from your website.

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

Quick Install

Run this command in your terminal to add the MCP server:

terminal

claude mcp add --transport http yavy https://yavy.dev/mcp/<your-project>

or configure manually

.mcp.json

Manual Setup Steps

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

Tip

The .mcp.json file in your project directory makes the MCP server available to your team. Public sources work instantly; private sources prompt for OAuth 2.1 login.

Claude Web (claude.ai)

Setup Custom Connector

1
Go to claude.ai and click on your profile icon
2
Navigate to Settings > Connectors
3
Click Add custom connector
4
Fill in the connector details:
Name:Yavy
Remote MCP Server URL:https://yavy.dev/mcp/<your-project>
5
Click Add to save your connector

Note

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