vueuse-mcp

Name: vueuse-mcp
Author: kovoor

本地服务

github.com/kovoor开发工具535 周前更新

代码仓库

关于 vueuse-mcp

vueuse-mcp 是供使用 VueUse 的编码 Agent 接入的 MCP 服务，可搜索组合式函数文档，并根据使用场景提供建议，涵盖 API 详情和示例。

主要功能

01按名称或概念搜索组合式函数
02获取签名、类型、选项和示例
03根据自然语言场景推荐组合式函数
04浏览分类及组合式函数数量

适用场景

01为编码任务查找 VueUse 组合式函数
02核对组合式函数的 API 和用法示例
03根据需求描述比较推荐的组合式函数

MCP 相关

向 MCP 客户端（如编码 Agent）提供 VueUse 搜索、文档、建议和分类工具。

配置

本地服务的配置在各客户端中通用，复制后粘贴到客户端的 MCP 配置文件即可。

mcp.json · 通用配置

{
  "mcpServers": {
    "kovoor-vueuse": {
      "command": "npx",
      "args": [
        "-y",
        "vueuse-mcp"
      ]
    }
  }
}

启动命令npx -y vueuse-mcp

本地服务需要在你的电脑上安装运行环境（如 Node.js 18+）。各客户端的配置文件位置不同，请参考客户端文档。

安装包

npmvueuse-mcp1.0.0stdio

工具

收录的工具列表 · 更新于 2 周前

参数	类型	必填	说明
limit	number	否	要返回的最大结果数（默认值为 10）
query	string	是	搜索查询——函数名称、关键字或概念
package	string	否	按软件包筛选（例如 "core"、"shared"、"integrations"）
category	string	否	按类别筛选（例如 "Browser"、"State"、"Sensors"）

详细介绍

VueUse MCP

为 AI 编码 Agent 提供 VueUse 文档即时访问能力的 MCP 服务——搜索组合式函数、阅读文档并获取建议。

编码时的工作方式

这是一个 MCP（Model Context Protocol）服务。将它连接到 Claude Code 之类的 AI 编码 Agent 后，Agent 就能在帮助你编写代码时自动查阅 VueUse 文档。

例如，如果你请求“帮我跟踪 Vue 中的鼠标位置”，Agent 将会：

调用 search_composables 或 suggest_composable 查找相关的组合式函数
调用 get_composable_docs 阅读 useMouse 的完整文档
使用正确的 API、选项和类型编写代码——你无需自行查阅

你无需手动调用任何工具。Agent 会根据你的问题决定何时使用它们。

快速开始

Claude Code

claude mcp add vueuse-mcp -- npx vueuse-mcp

Codex CLI

添加到 MCP 配置中：

{
  "servers": {
    "vueuse": {
      "command": "npx",
      "args": ["vueuse-mcp"]
    }
  }
}

OpenCode

添加到你的 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

设置 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