You're viewing Avo 2 docs — go to Avo 4

Skip to content

Windsurf Windsurf ​

Setup Windsurf to correctly generate Avo code based on your prompt.

Quick use ​

In chat window type this and write your prompt.

bash
@web https://docs.avohq.io/2.0/docs-map.md

Permanent setup ​

Windsurf reads the AGENTS.md file from your repository. Add a line pointing to Avo's docs:

bash
When working with Avo, use the docs at https://docs.avohq.io/2.0/docs-map.md as a reference.

MCP server ​

MCP (Model Context Protocol) connects coding agents to external tools and context. Windsurf can use MCP servers to look up documentation while working.

I suggest using Context7 MCP server which provides many libraries including Avo's docs.

  1. Press ⌘ CMD+⇧ Shift+P (or ⌃ Ctrl+⇧ Shift+P on Windows)

  2. Type Windsurf: Configure MCP Servers

  3. Click Add custom server

  4. Add this:

json
// mcp_config.json
{
  "mcpServers": {
  "context7": {
    "command": "npx",
    "args": ["-y", "@upstash/context7-mcp@latest"]
  }
  }
}
  1. Fully quit and reopen Windsurf so the server loads.

Now you can ask AI anything about Avo, and write use context7 at the end of your prompt.

For example:

bash
create a new Avo resource for a product model. use context7