Getting Started
The fastest way to start using Vue Docs MCP is to connect to the free hosted server at mcp.vue-mcp.org. No API keys or setup required.
Connect Your Client
Claude Code
One command:
bash
claude mcp add --scope user vue-docs --transport streamable-http https://mcp.vue-mcp.org/mcpCursor
One-click install:
Or add to .cursor/mcp.json:
json
{
"mcpServers": {
"vue-docs": {
"url": "https://mcp.vue-mcp.org/mcp"
}
}
}Other Clients
See the MCP Clients section for detailed setup instructions for Claude Desktop, Windsurf, VS Code, JetBrains, Zed, ChatGPT, and more.
For any client not listed, use the streamable HTTP transport with this URL:
https://mcp.vue-mcp.org/mcpTry It Out
Once connected, ask your AI assistant a Vue question. It will use the MCP tools automatically:
- "How does
v-modelwork on custom components?" - "What lifecycle hooks are available in Vue 3?"
- "Show me the
definePropsAPI" - "Compare
watchvswatchEffect"
Look for tool calls like vue_docs_search or vue_api_lookup in the response.
What's Available
| Type | What it does |
|---|---|
| Tools | Search docs, look up APIs, find related content |
| Resources | Browse the documentation tree, read raw pages |
| Prompts | Guided workflows for debugging, comparison, migration |
Next Steps
- MCP Clients: Setup guides for all supported clients
- Tools Reference: Full documentation of search tools
- How It Works: Technical details of the search pipeline
- Self-Hosting: Run your own instance