Quasar Docs MCP

Quasar Docs MCP服务器

MCP（模型上下文协议）服务器，提供对 类星体框架 直接从Claude Code和其他MCP兼容客户端获取文档。

特性

• 搜索文档 -对所有Quasar文档进行分页全文搜索
• 获取组件文档 -检索任何类星体组件（q-btn、q-input等）的文档
• 获取任何页面 -按路径获取任何文档页面
• 列出章节 -浏览可用的文档部分
• 智能缓存 -页面缓存30分钟，索引缓存1小时
• 多种响应格式 -获取Markdown或JSON格式的输出
• 字符限制处理 -自动截断，消息清晰

安装

选项1:npx（推荐）

无需安装即可直接添加到Claude代码中：

claude mcp add quasar-docs -- npx quasar-docs-mcp

选项2：从npm安装

npm install -g quasar-docs-mcp-server

然后添加到克劳德代码中：

claude mcp add quasar-docs -- quasar-docs-mcp

选项3：克隆和构建

# Clone the repository
git clone https://github.com/aliaks-ei/quasar-docs-mcp.git
cd quasar-docs-mcp

# Install dependencies and build
npm install
npm run build

然后使用绝对路径添加到Claude Code中：

# Project-scoped (recommended for Quasar projects)
claude mcp add --scope project quasar-docs -- node /absolute/path/to/quasar-docs-mcp/dist/index.js

# Or user-scoped (available in all projects)
claude mcp add --scope user quasar-docs -- node /absolute/path/to/quasar-docs-mcp/dist/index.js

验证安装

添加服务器后，验证其是否正常工作：

claude mcp list

你应该看看 quasar-docs 在已配置的服务器列表中。

可用工具

quasar_get_component

获取特定Quasar UI组件的文档。

参数：

• component （字符串，必填）：组件名称（例如，“btn”、“q-btn”，“input”、“dialog”、“button”）
• response_format （字符串，可选）：输出格式-“markdown”（默认）或“json”

示例：

Get the documentation for q-btn
Show me q-input props and events

quasar_get_page

按路径获取任何Quasar文档页面。

参数：

• path （字符串，必填）：页面路径（例如，“样式/调色板”、“类星体插件/通知”）
• response_format （字符串，可选）：输出格式-“markdown”（默认）或“json”

示例：

Get the Quasar color palette documentation
Show me the Notify plugin docs

quasar_search_docs

在Quasar文档中搜索主题。

参数：

• query （字符串，必填）：搜索查询
• section （字符串，可选）：将搜索限制在特定部分
• limit （数字，可选）：最大结果1-50（默认值：10）
• offset （数字，可选）：分页时跳过的结果（默认值：0）
• include_content （布尔值，可选）：在文件内容中搜索（速度较慢但更彻底）
• response_format （字符串，可选）：输出格式-“markdown”（默认）或“json”

示例：

Search for form validation in Quasar docs
Find dark mode configuration

quasar_list_sections

列出可用的文档部分或部分中的页面。

参数：

• section （字符串，可选）：显示此部分中的页面
• response_format （字符串，可选）：输出格式-“markdown”（默认）或“json”

示例：

List all Quasar documentation sections
List pages in the vue-components section

文件部分

服务器提供对所有Quasar文档部分的访问：

响应格式

所有工具都支持两种响应格式：

• 标记语言 （默认）：人类可读的格式化文本，非常适合显示
• JSON：机器可读的结构化数据，非常适合程序化处理

JSON格式示例：

Search for button with response_format="json"

运作原理

服务器直接从 (docs/src/pages/).它使用：

1. GitHub原始文件 -用于获取单个文档页面
2. GitHub API -用于列出目录内容和构建搜索索引
3. 内存缓存 -页面缓存30分钟，索引缓存1小时

环境变量

• GITHUB_TOKEN （可选）：设置为将GitHub API速率限制从每小时60个请求增加到5000个请求

故障排除

“找不到组件”

组件名称可能与预期不同。使用 quasar_search_docs 要查找正确的名称：

search for button component

速率限制

服务器使用GitHub的API，该API有速率限制（未经验证的请求为60个请求/小时）。内置缓存有助于缓解这种情况。如果你达到了极限，请等待一个小时或设置一个 GITHUB_TOKEN 环境变量，将限制增加到5000个请求/小时。

服务器无响应

1. 确保服务器已构建： npm run build
2. 验证中的路径 claude mcp add 是正确的
3. 检查克劳德代码日志： claude mcp logs quasar-docs

删除服务器

claude mcp remove quasar-docs

发展

# Watch mode for development
npm run dev

# Build
npm run build

# Run the server directly
npm start

贡献

欢迎投稿！请随时提交拉取请求。

许可证

麻省理工学院