Setup time: ~2 minutes

Connect Yavy to Cursor

Supercharge your Cursor IDE with access to your documentation. Search API references, framework guides, and technical docs directly from your editor, or generate Skills packages for offline use.

Why Use Yavy with Cursor?

Cursor is built for AI-assisted coding, but its knowledge is limited to training data. By connecting Yavy, you give Cursor access to your specific documentation - the exact APIs, patterns, and conventions your project uses. Stop guessing and start coding with confidence.

  • Search documentation without leaving your editor
  • Get code suggestions grounded in real API references
  • Instant lookup of framework patterns and best practices
  • Reduce context switching between docs and code
  • Works seamlessly with Cursor's AI features

Example Workflow

You're writing code and ask Cursor:

"How do I validate a form in Vue 3 with Vuelidate?"

Cursor searches your indexed Vuelidate docs:

"Based on the Vuelidate documentation, here's how to set up form validation..." [includes working code example]

Setup Instructions

1

Create a Yavy Project

You need a Yavy project with your documentation indexed. If you haven't set one up:

  1. Sign up for a free Yavy account
  2. Create a new project with your documentation URL
  3. Wait for indexing to complete
  4. Copy your MCP server URL from the dashboard
2

Install Cursor

Make sure you have Cursor installed. You can download it from their official website. Cursor supports MCP servers natively for enhanced AI capabilities.

Download Cursor
3

Configure MCP Server

Add your Yavy MCP server to Cursor's configuration. Follow the instructions below:

mcp.json

Setup Steps

  1. 1

    Create or open the configuration file:

    Global:~/.cursor/mcp.json
    Project:.cursor/mcp.json
  2. 2
    Copy the configuration above and paste it into your mcp.json file
  3. 3
    Restart Cursor for changes to take effect

Alternative: Use Cursor Settings

Go to Cursor Settings > Features > MCP and click + Add New MCP Server to configure visually.
4

Reload and Start Coding

After saving the configuration:

  1. Reload Cursor (Cmd/Ctrl + Shift + P → "Reload Window")
  2. Authenticate with your Yavy account when prompted
  3. Start asking questions about your documentation!
  4. Cursor will automatically search your indexed content

Alternative: Use Skills Packages

Prefer offline access? Generate Skills packages with the Yavy CLI and place them in your project directory. Skills files can be used as project context in Cursor - no server connection needed at runtime.

terminal
npm install -g @yavydev/cli
yavy login
yavy generate your-org/your-project

Skills work offline and can be version-controlled with your code. Full CLI reference

Tips for Best Results

Be Specific

Instead of "how do I use X", try "show me an example of X from the docs" or "what does the documentation say about X".

Index Multiple Sources

Create projects for each framework or library you use. The more documentation Cursor can access, the more accurate its suggestions.

Keep Content Fresh

Yavy automatically syncs content, but you can trigger a manual re-index from the dashboard when docs are updated.

Use in Composer

Cursor's Composer feature works great with Yavy. Ask it to implement features following patterns from your indexed documentation.

Ready to Supercharge Cursor?

Create your Yavy account and index your documentation. You'll have Cursor connected in just a few minutes.