ionic-framework-mcp

Ionic Framework MCP 服务

面向官方 Ionic Framework 文档的非官方 MCP 服务。它为 AI 助手提供 Ionic Framework v9 和 v8 的最新文档，包括组件 API 参考、Angular、React、Vue 和原生 JavaScript 的用法示例，以及 Ionic 博客。与 Ionic 或 OutSystems 无关联，也未获得其认可。

由 Capawesome 维护。

端点

服务已托管并可立即使用。无需账号、令牌或安装：

https://ionic-framework-mcp.capawesome.io/mcp

安装

Claude Code

claude mcp add --transport http ionic-framework https://ionic-framework-mcp.capawesome.io/mcp

Claude Desktop / Claude.ai

前往 Settings → Connectors → Add custom connector 并输入：

• 名称：Ionic Framework
• URL：https://ionic-framework-mcp.capawesome.io/mcp

Cursor

或者在项目中添加 .cursor/mcp.json：

{
  "mcpServers": {
    "ionic-framework": {
      "url": "https://ionic-framework-mcp.capawesome.io/mcp"
    }
  }
}

VS Code

在 VS Code 中安装

或者在项目中添加 .vscode/mcp.json：

{
  "servers": {
    "ionic-framework": {
      "type": "http",
      "url": "https://ionic-framework-mcp.capawesome.io/mcp"
    }
  }
}

Windsurf

将服务添加到 ~/.codeium/windsurf/mcp_config.json：

{
  "mcpServers": {
    "ionic-framework": {
      "serverUrl": "https://ionic-framework-mcp.capawesome.io/mcp"
    }
  }
}

Zed

将服务添加到 Zed 的 settings.json：

{
  "context_servers": {
    "ionic-framework": {
      "url": "https://ionic-framework-mcp.capawesome.io/mcp"
    }
  }
}

通过 npx 使用任意客户端

无法通过 HTTP 连接远程服务的客户端，可以运行此软件包，由它将标准输入输出代理到托管服务：

{
  "mcpServers": {
    "ionic-framework": {
      "command": "npx",
      "args": ["-y", "@capawesome/ionic-framework-mcp"]
    }
  }
}

需要 Node.js 22 或更高版本。

工具

工具	用途	参数
search_docs	按关键词搜索文档。遇到任何 Ionic Framework 相关问题，都从这里开始。	query（必填）、section、version、limit
get_doc_page	阅读 search_docs 返回的完整文档页面。	url（必填）、version
list_components	列出 Ionic Framework 组件及其 API 参考。	query、version、limit
get_component_usage	按框架阅读组件的用法示例。	component（必填）、example、framework、version
list_blog_posts	列出 Ionic 博客的最新文章。	—

版本

文档提供 Ionic Framework v9（默认）和 v8 版本。传入 version 参数即可指定目标版本。

速率限制

此端点的速率限制为每个 IP 每分钟 100 个请求。超出限制的请求会收到 429 Too Many Requests；请稍等片刻后重试。

隐私

你的 IP 地址仅用于速率限制。查询和工具参数不会被存储，也不会记录在 Cloudflare 标准边缘日志之外，并且绝不会用于训练。详情请参阅隐私政策。

相关项目

• Capacitor MCP Server — 同样适用于 Capacitor 文档、插件列表和博客。
• Capawesome MCP Server — 用于 Capawesome 文档和 Capawesome Cloud 管理 API 的官方 MCP 服务。
• Capawesome Cloud Live Updates — 无需应用商店审核，即可将 JavaScript、HTML 和 CSS 更改发布到应用中。
• Capawesome Cloud Native Builds — 在云端构建原生 iOS 和 Android 应用，无需 Mac。
• Capawesome Cloud App Store Publishing — 将构建版本提交到 Apple App Store 和 Google Play Store。

归属声明

文档内容版权归 Ionic 团队所有，依据 Apache-2.0 授权，来源为 ionic-team/ionic-docs。内容从 MDX 转换为 Markdown，以便通过 MCP 交付；除此之外，实质内容均保持原样。组件 API 参考来自 @ionic/docs 软件包（MIT）。博客摘录来自 Ionic 博客，并链接到原文。

完整归属信息请参阅 NOTICE。

开发

npm install
npm run build
npm test

将 IONIC_FRAMEWORK_MCP_URL 设置为本地服务地址，让代理指向本地服务而不是托管服务：

IONIC_FRAMEWORK_MCP_URL=http://localhost:8787/mcp node dist/index.js

发布

版本发布由 release-please 管理。合并其发布拉取请求后，会为版本创建标签、将软件包发布到 npm，然后将 server.json 发布到 MCP Registry。server.json 中的版本由 release-please 与 package.json 一起更新，因此无需手动编辑。若要手动发布到注册表，请安装 mcp-publisher，使用密码管理器中的 Ed25519 私钥运行 mcp-publisher login dns --domain=capawesome.io --private-key=<key>，然后运行 mcp-publisher publish。

许可证

请参阅 LICENSE。