Yavy Logo
Yavy
Back to Integrations
Setup time: ~2 minutes

Connect Yavy to Windsurf

Give your Windsurf AI coding companion access to real documentation, or generate Skills packages for offline use. Stop the guesswork and get accurate, sourced answers while you code.

Why Use Yavy with Windsurf?

Windsurf is a powerful AI coding assistant, but like all AI tools, it can make things up when it doesn't have access to specific documentation. By connecting Yavy, you give Windsurf access to your actual documentation - APIs, frameworks, internal guides, and more.

  • Access documentation directly in Windsurf chat
  • Get accurate code suggestions based on real API docs
  • Reduce hallucinations with grounded information
  • Seamless integration with Windsurf's AI capabilities
  • Automatic source attribution for every answer

Real Example

You ask Windsurf:

"How do I set up SSR with Inertia.js and Vue 3?"

Windsurf searches your Inertia docs:

"According to the Inertia.js documentation, here's how to configure server-side rendering..." [with correct config examples]

Setup Instructions

1

Create a Yavy Project

First, set up a Yavy project to index your documentation:

  1. Sign up for a free Yavy account
  2. Create a project and add your documentation URL
  3. Wait for the indexing to complete
  4. Copy your unique MCP server URL
2

Install Windsurf

Ensure you have Windsurf installed on your system. Windsurf supports MCP servers for connecting to external knowledge sources like Yavy.

Download Windsurf
3

Configure MCP Server

Add your Yavy MCP server to Windsurf's settings. Follow the platform-specific instructions:

mcp_config.json

Setup Steps

  1. 1

    Open Windsurf Settings:

    Press Ctrl+Shift+P (or Cmd+Shift+P on macOS)

    Type Open Windsurf Settings

  2. 2
    Navigate to Cascade → MCP Servers and click Add Server
  3. 3
    Select Add custom server + to open the raw config
  4. 4
    Copy the configuration above and merge it into your mcp_config.json
  5. 5
    Restart Windsurf for changes to take effect

Config File Location

The configuration file is located at ~/.codeium/windsurf/mcp_config.json
4

Restart and Connect

After configuring:

  1. Restart Windsurf completely
  2. Complete OAuth authentication when prompted
  3. Start asking questions about your indexed documentation
  4. Windsurf will search your content automatically

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 Windsurf - 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

Great Use Cases

Framework Documentation

Index React, Vue, Next.js, or any framework docs. Get accurate API usage examples while coding instead of outdated training data.

Internal APIs

Index your company's internal API documentation. Windsurf can help you use internal services correctly without switching context.

Library References

Connect documentation for libraries like Tailwind, Prisma, or Stripe. Get correct syntax and patterns on demand.

Project Wikis

Index your team's Notion, Confluence, or GitHub wikis. Access institutional knowledge directly in your editor.

Ready to Enhance Windsurf?

Create your Yavy account and start indexing your documentation. Connect Windsurf in minutes and code with confidence.