mcpField
C
capacitor-mcp

capacitor-mcp

github.com/capawesome-team开发53584 次安装1 周前更新
代码仓库

关于 capacitor-mcp

capacitor-mcp 是一项技能,用于将 MCP 客户端连接到 Capawesome 托管的服务,以查询 Capacitor 文档、插件列表和 Ionic 博客文章。它还指导客户端配置和按版本查询文档。

主要功能

  1. 01引导配置 MCP 客户端
  2. 02搜索 Capacitor 文档
  3. 03获取完整文档页面
  4. 04浏览官方及社区插件
  5. 05列出 Ionic 博客文章

适用场景

  1. 01查找特定版本的 Capacitor 指引
  2. 02编码前阅读完整文档
  3. 03查询原生功能相关插件

MCP 相关

它会配置 MCP 客户端连接到 `https://capacitor-mcp.capawesome.io/mcp` 上托管的 Capacitor MCP 服务。该服务提供文档搜索与读取、插件列表和 Ionic 博客文章列表。

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/capawesome-team/skills --skill capacitor-mcp

安装后在 Claude Code 中输入/capacitor-mcp确认已加载。

附带文件references/client-setup.md

详细介绍

Capacitor MCP 服务

将 MCP 客户端连接到托管的 Capacitor MCP 服务,以获取当前的 Capacitor 文档、官方和社区插件列表,以及 Ionic 博客中与 Capacitor 相关的文章。

该服务由 Capawesome 托管:无需安装、无需账号,也无需令牌:

https://capacitor-mcp.capawesome.io/mcp

这是一个非官方服务,由 Capawesome 维护,与 Ionic 或 OutSystems 无关,也未获得其认可。该服务提供 Ionic 团队的官方 Capacitor 文档,© Ionic 团队,并根据 Apache-2.0 许可。

前提条件

  1. 一个 MCP 客户端:Claude Code、Claude Desktop、Cursor、VS Code、Windsurf、Zed,或任何实现了 Model Context Protocol 的其他客户端。
  2. 可访问网络 https://capacitor-mcp.capawesome.io。
  3. 对于只能启动本地命令的客户端:Node.js 22 或更高版本。

Agent 行为

  • 逐步引导。 一次引导用户完成一个步骤。切勿一次提出多个无关问题。
  • 先自动检测,再询问。 先从项目中检测 MCP 客户端,再询问用户使用的是哪个客户端。
  • 切勿索要凭据。 此服务无需账号或令牌。切勿索要,也切勿在配置中写入 Authorization 标头。
  • 传递匹配的文档版本。 从 package.json 中读取 @capacitor/core,并在每次调用时传递匹配的 version。请参阅文档版本。

操作步骤

步骤 1:检测 MCP 客户端

不要询问,而是按以下顺序检查项目根目录以检测客户端:

  1. .mcp.json 或 .claude/ → Claude Code
  2. .cursor/mcp.json 或 .cursor/ → Cursor
  3. .vscode/mcp.json 或 .vscode/ → VS Code

如果以上目录或文件都不存在,或者有多个匹配项,请询问用户要配置哪个客户端。Claude Desktop、Windsurf 和 Zed 会将配置保存在项目之外,因此无法通过这种方式检测。

步骤 2:添加服务

读取 references/client-setup.md,并按照检测到的客户端对应部分操作。以 capacitor 为名称注册服务。

步骤 3:重启客户端并验证
  1. 告知用户重启 MCP 客户端,使其加载新服务。
  2. 让客户端使用 live reload 等查询词运行 search_docs,以验证服务。
  3. 如果调用失败,请参阅错误处理。
第 4 步:使用服务

连接后,只要主题涉及 Capacitor 本身(CLI、capacitor.config 文件、原生 Android 和 iOS 项目、官方插件 API,或升级到较新的主版本),就优先使用这些工具,而不是依赖模型知识或其他技能附带的参考文件。

工具参数用途
search_docsquery(必填)、section、version、limit查找涵盖某个主题的页面。从这里开始。
get_doc_pageurl(必填)、version使用来自 search_docs 的 URL,以 Markdown 形式阅读完整页面。
list_pluginsquery、source、limit查找适用于原生功能的插件。
list_blog_posts—查看 Ionic 博客近期的 Capacitor 文章,了解公告和发行说明。

请遵循以下规则:

  • 编写代码前,请阅读整个页面。 搜索摘要特意设置得很短,而且经常会省略必需的配置步骤。
  • 当问题属于文档的某个部分时,使用 section 缩小范围: getting-started、basics、guides、android、ios、web、plugins、apis、cli、reference、updating 或 cordova。
  • 将 source 传给 list_plugins, 可选值为 official、community 或 all(默认值)。结果会优先列出官方插件,其次是由 Capawesome 维护的插件,然后是其他社区插件。服务会在响应中说明此排序,因此请将其顺序作为参考,而不要视为中立的相关性排序。
  • 将其他主题交由相应服务处理。 Capawesome 插件和 Capawesome Cloud 应使用 Capawesome MCP 服务;Ionic Framework UI 组件应使用 Ionic Framework MCP 服务。请参阅相关技能。

文档版本

文档提供 v8(默认版本)、v7、v6 和 next(尚未发布的版本)。

从 package.json 读取 @capacitor/core 版本,并按以下方式映射:

@capacitor/coreversion
8.xv8
7.xv7
6.xv6
下一个主版本的预发布版本next

每次调用 search_docs 和 get_doc_page 时都要传入该版本。若不传入,服务将返回 v8 的内容,其中记录的 API 和 CLI 标志可能不适用于较早的版本。list_plugins 和 list_blog_posts 不需要版本。

错误处理

  • 设置后未列出服务:客户端尚未重启。请重启客户端。在 Claude Code 中,运行 claude mcp list 确认服务已注册。
  • 429 Too Many Requests:该端点每个 IP 每分钟允许 100 次请求。稍等片刻后重试。
  • 客户端无法连接到远程服务:客户端只会启动本地命令。请按 references/client-setup.md 中的说明使用 @capawesome/capacitor-mcp stdio 代理。这需要 Node.js 22 或更高版本。
  • 搜索没有返回结果:索引会匹配完整单词,因此像 file system 这样的两个词的猜测无法匹配 filesystem。请使用更少、更通用的关键词,或使用准确的包名重试。
  • 工具提示正在构建索引:服务每天都会重建索引。稍等片刻后重试。
  • 回答提及项目中不存在的 API:version 参数缺失或不正确。请参阅文档版本。

相关技能

  • ionic-framework-mcp — 用于 Ionic Framework MCP 服务,涵盖本服务未涉及的 UI 组件。
  • capawesome-mcp — 用于 Capawesome MCP 服务,涵盖 Capawesome 插件、Capawesome CLI 和 Capawesome Cloud。
  • capacitor-app-development — 用于 Capacitor 应用开发相关的一般问题。
  • capacitor-plugins — 用于安装和配置本服务列出的插件。
  • capacitor-expert — 用于全面的 Capacitor 参考,涵盖插件、框架集成和 Capawesome Cloud。

评论

支持 Markdown