Unofficial MCP server for the Ionic Framework documentation, components and blog.
Unofficial MCP server for the official Ionic Framework documentation. It gives AI assistants the current documentation for Ionic Framework v9 and v8 — including the component API reference and the usage examples for Angular, React, Vue and vanilla JavaScript — plus the Ionic blog. Not affiliated with or endorsed by Ionic or OutSystems.
Maintained by Capawesome.
The server is hosted and ready to use. No account, no token, no installation:
https://ionic-framework-mcp.capawesome.io/mcp
claude mcp add --transport http ionic-framework https://ionic-framework-mcp.capawesome.io/mcp
Go to Settings → Connectors → Add custom connector and enter:
Ionic Frameworkhttps://ionic-framework-mcp.capawesome.io/mcpOr add .cursor/mcp.json to your project:
{
"mcpServers": {
"ionic-framework": {
"url": "https://ionic-framework-mcp.capawesome.io/mcp"
}
}
}
Or add .vscode/mcp.json to your project:
{
"servers": {
"ionic-framework": {
"type": "http",
"url": "https://ionic-framework-mcp.capawesome.io/mcp"
}
}
}
Add the server to ~/.codeium/windsurf/mcp_config.json:
{
"mcpServers": {
"ionic-framework": {
"serverUrl": "https://ionic-framework-mcp.capawesome.io/mcp"
}
}
}
Add the server to your Zed settings.json:
{
"context_servers": {
"ionic-framework": {
"url": "https://ionic-framework-mcp.capawesome.io/mcp"
}
}
}
Clients that cannot connect to a remote server over HTTP can run this package, which proxies stdio to the hosted server:
{
"mcpServers": {
"ionic-framework": {
"command": "npx",
"args": ["-y", "@capawesome/ionic-framework-mcp"]
}
}
}
Requires Node.js 22 or later.
| Tool | Purpose | Parameters |
|---|---|---|
search_docs | Search the documentation by keyword. Start here for any Ionic Framework question. | query (required), section, version, limit |
get_doc_page | Read a full documentation page returned by search_docs. | url (required), version |
list_components | List Ionic Framework components with their API reference. | query, version, limit |
get_component_usage | Read usage examples for a component, per framework. | component (required), example, framework, version |
list_blog_posts | List recent posts from the Ionic blog. | — |
The documentation is available for Ionic Framework v9 (default) and v8. Pass the version parameter to target a specific version.
The endpoint is limited to 100 requests per minute per IP. Requests over the limit are answered with 429 Too Many Requests; retry after a short wait.
Your IP address is processed for rate limiting only. Queries and tool arguments are not stored, not logged beyond Cloudflare's standard edge logs, and never used for training. See the Privacy Policy for details.
The documentation content is © the Ionic team, licensed under Apache-2.0 and sourced from ionic-team/ionic-docs. It is converted from MDX to Markdown for delivery over MCP and otherwise served unmodified in substance. The component API reference comes from the @ionic/docs package (MIT). Blog excerpts come from the Ionic blog and link to the original post.
See NOTICE for the full attribution.
npm install
npm run build
npm test
Set IONIC_FRAMEWORK_MCP_URL to point the proxy at a local server instead of the hosted one:
IONIC_FRAMEWORK_MCP_URL=http://localhost:8787/mcp node dist/index.js
Releases are managed by release-please. Merging its release pull request tags the version, publishes the package to npm and then publishes server.json to the MCP Registry. The version in server.json is bumped by release-please together with package.json, so it never has to be edited by hand. To publish to the registry manually, install mcp-publisher, run mcp-publisher login dns --domain=capawesome.io --private-key=<key> with the Ed25519 private key from the password manager and then mcp-publisher publish.
See LICENSE.
Source-derived launch command. Check the maintainer’s required arguments and credentials before running:
npx -y @capawesome/ionic-framework-mcpMerge this template into ~/Library/Application Support/Claude/claude_desktop_config.json. Keep existing servers. Add any arguments, credentials, and permissions required by the maintainer; this template has not been install-tested.
{
"mcpServers": {
"io-capawesome-ionic-framework-mcp": {
"command": "npx",
"args": [
"-y",
"@capawesome/ionic-framework-mcp"
]
}
}
}Restart Claude Desktop completely for changes to take effect. Confirm the server appears connected in the client’s tool list, then try a read-only example from its documentation.
Claude Desktop setup reference@capawesome/ionic-framework-mcpnpmio.capawesome/ionic-framework-mcp works with any MCP-compatible client. Copy the config snippet from the Configuration section above and add it to the file shown for your client, then restart the application.
~/Library/Application Support/Claude/claude_desktop_config.jsonRestart Claude Desktop completely for changes to take effect.~/.cursor/mcp.jsonRestart Cursor for changes to take effect..vscode/mcp.jsonReload VS Code window for changes to take effect.~/.codeium/windsurf/mcp_config.jsonRestart Windsurf for changes to take effect..mcp.jsonSave at the project root, then start Claude Code in that project and review the MCP server approval prompt. Keep real credentials out of shared files.