使用 MCP
MCP服务器，使AI编码代理能够即时访问VueUse文档——搜索可组合文件、阅读文档并获取建议。
当你编码时，它是如何工作的
这是一个 MCP（模型上下文协议） 服务器。当您将其连接到像Claude Code这样的AI编码代理时，该代理可以自动查找VueUse文档，同时帮助您编写代码。
例如，如果你问“帮助我跟踪Vue中的鼠标位置”，代理将：
- 呼叫
search_composables或suggest_composable寻找相关的可堆肥材料 - 呼叫
get_composable_docs阅读以下内容的完整文档useMouse - 使用正确的API、选项和类型编写代码，而无需查找任何内容
您不需要手动调用任何工具。客服根据您的问题决定何时使用它们。
快速开始
克劳德代码
claude mcp add vueuse-mcp -- npx vueuse-mcpCodex CLI
添加到MCP配置中：
{
"servers": {
"vueuse": {
"command": "npx",
"args": ["vueuse-mcp"]
}
}
}开源代码
添加到您的 opencode.json:
{
"mcp": {
"vueuse": {
"command": "npx",
"args": ["vueuse-mcp"]
}
}
}可用工具
| 工具 | 说明 |
|---|---|
search_composables | 按名称、关键字或概念搜索。返回带有描述的排名结果。 |
get_composable_docs | 获取可组合的完整文档——签名、类型、选项、示例、相关函数。 |
suggest_composable | 用自然语言描述一个用例，并通过权衡获得排名建议。 |
list_categories | 列出所有具有可组合计数的类别。可选择按包过滤。 |
保持数据新鲜
可组合数据是从VueUse GitHub仓库中抓取的。要更新，请执行以下操作：
npm run scrape && npm run build集合A GITHUB_TOKEN 环境变量，以避免抓取过程中的速率限制。看 .env.example.
发展
git clone https://github.com/kovoor/vueuse-mcp.git
cd vueuse-mcp
npm install
npm run scrape # fetch composable data from GitHub
npm run build # compile TypeScript
npm start # run the server贡献
看 贡献.md 了解如何添加工具、更新抓取管道和提交PR。