MCPcopy Index your code
hub / github.com/Tommertom/awesome-ionic-mcp

github.com/Tommertom/awesome-ionic-mcp @v0.1.23

Chat with this repo
repository ↗ · DeepWiki ↗ · release v0.1.23 ↗ · + Follow
39 symbols 145 edges 36 files 0 documented · 0%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Awesome Ionic MCP server

Your comprehensive Ionic coding companion powered by the Model Context Protocol (MCP). This intelligent server provides seamless access to Ionic Framework components, Capacitor plugins, and developer resources to accelerate your mobile app development workflow. Whether you're building cross-platform applications with React, Angular, Vue, or Vanilla JavaScript, this MCP server delivers real-time component definitions, API documentation, code examples, and plugin information directly to your AI assistant, enabling faster development and better code quality.

Data is sourced from the package @ionic/core, ionicframework.com, docs-demo.ionic.io, capacitorjs.com, capawesome.io, capacitor-community, and capgo.live to ensure accuracy and completeness.

Tools available

Tool Name Feature Group Description
get_ionic_component_definition @ionic/core.json Retrieves the typescript definition of an Ionic component based on its HTML tag.
get_all_ionic_components @ionic/core.json Retrieves the list of all Ionic components available for this tool
get_component_api ionicframework.com Retrieves the component API on from the IonicFramework page using its HTML tag.
get_component_demo docs-demo.ionic.io Returns the component demo from the GitHub repository based on its HTML tag.
get_official_plugin_api capacitorjs.com Retrieves the official plugin API on from the Capacitor page using its HTML tag.
get_all_official_plugins capacitorjs.com Retrieves list of all Official Capacitor plugins.
get_all_plugins capawesome.io Retrieves list of all Capawesome Capacitor plugins (free and insider versions).
get_all_free_plugins capawesome.io Retrieves list of all Capawesome Capacitor free plugins - intensively curated and up-to-date.
get_all_insider_plugins capawesome.io Retrieves list of all Capawesome Capacitor insider plugins - intensively curated and up-to-date.
get_plugin_api capawesome.io Retrieves API documentation for a specific Capawesome Capacitor plugin.
get_capacitor_community_plugin_api capacitor-community Retrieves API documentation for a specific Capacitor Community plugin.
get_all_capacitor_community_plugins capacitor-community Retrieves list of all Capacitor Community plugins.
get_capgo_plugin_api capgo Retrieves API documentation for a specific CapGo plugin.
get_all_capgo_plugins capgo Retrieves list of all CapGo plugins.
get_all_capacitor_plugins all-capacitor-plugins Superlist of all Capacitor plugings from different publishers you can use to retrieve API information through this MCP tool. If you are lost about which plugin to use, this tool will help you find the right one.

Getting started & upfront warning

The Awesome Ionic MCP server can work with any MCP client that supports standard I/O (stdio) as the transport medium. Here are specific instructions for some popular tools:

Just to let you know - for some data the MCP server will run Puppeteer to open a browser and get the data. So you will see a browser window spanwed and closed.

Basic configuration

Claude Desktop

To configure Claude Desktop to use the Awesome Ionic MCP server, edit the claude_desktop_config.json file. You can open or create this file from the Claude > Settings menu. Select the Developer tab, then click Edit Config.

{
  "mcpServers": {
    "awesome-ionic-mcp": {
      "command": "npx",
      "args": ["-y", "awesome-ionic-mcp@latest"]
    }
  }
}

Cline

To configure Cline to use the Awesome Ionic MCP server, edit the cline_mcp_settings.json file. You can open or create this file by clicking the MCP Servers icon at the top of the Cline pane, then clicking the Configure MCP Servers button.

{
  "mcpServers": {
    "awesome-ionic-mcp": {
      "command": "npx",
      "args": ["-y", "awesome-ionic-mcp@latest"],
      "disabled": false
    }
  }
}

Cursor

To configure Cursor to use the Awesome Ionic MCP server, edit either the file .cursor/mcp.json (to configure only a specific project) or the file ~/.cursor/mcp.json (to make the MCP server available in all projects):

{
  "mcpServers": {
    "awesome-ionic-mcp": {
      "command": "npx",
      "args": ["-y", "awesome-ionic-mcp@latest"]
    }
  }
}

Environment Variables

The server supports optional environment variables for enhanced functionality:

GITHUB_TOKEN (Recommended)

Purpose: Authenticate GitHub API requests to avoid rate limiting

Why it's needed: The server fetches plugin data from GitHub organizations (CapGo, Capacitor Community). Without authentication, GitHub limits you to 60 API requests per hour per IP address. The server makes ~160+ API calls during initialization, which exhausts the unauthenticated limit in a single startup. With a token, the limit increases to 5,000 requests per hour.

How to get a token: 1. Go to GitHub Settings → Developer settings → Personal access tokens → Tokens (classic) 2. Click "Generate new token (classic)" 3. Give it a descriptive name (e.g., "Awesome Ionic MCP") 4. No special scopes/permissions needed for public repository access 5. Copy the generated token (starts with ghp_)

Configuration example:

{
  "mcpServers": {
    "awesome-ionic-mcp": {
      "command": "npx",
      "args": ["-y", "awesome-ionic-mcp@latest"],
      "env": {
        "GITHUB_TOKEN": "ghp_your_token_here"
      }
    }
  }
}

MCP_QUIET

Purpose: Suppress informational logs (only errors will be shown)

When to use: If you want minimal logging output

Configuration example:

{
  "mcpServers": {
    "awesome-ionic-mcp": {
      "command": "npx",
      "args": ["-y", "awesome-ionic-mcp@latest"],
      "env": {
        "MCP_QUIET": "true"
      }
    }
  }
}

Visual Studio Code Copilot

To configure a single project, edit the .vscode/mcp.json file in your workspace:

{
  "servers": {
    "awesome-ionic-mcp": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "awesome-ionic-mcp@latest"]
    }
  }
}

To make the server available in every project you open, edit your user settings:

{
  "mcp": {
    "servers": {
      "awesome-ionic-mcp": {
        "type": "stdio",
        "command": "npx",
        "args": ["-y", "awesome-ionic-mcp@latest"]
      }
    }
  }
}

Windsurf Editor

To configure Windsurf Editor, edit the file ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "awesome-ionic-mcp": {
      "command": "npx",
      "args": ["-y", "awesome-ionic-mcp@latest"]
    }
  }
}

Credits

Credits go to Firebase team- for using their code of their Firebase MCP server. https://firebase.google.com/docs/cli/mcp-server

Extension points exported contracts — how you extend this code

Core symbols most depended-on inside this repo

Shape

Function 20
Method 11
Interface 6
Class 2

Languages

TypeScript100%

Modules by API surface

src/mcp.ts13 symbols
src/tools/coreJson/utils.ts4 symbols
src/mcp-utils/utils.ts4 symbols
src/tools/index.ts3 symbols
src/mcp-utils/tools.ts3 symbols
src/tools/github-utils.ts2 symbols
src/tools/capgo/index.ts2 symbols
src/tools/capawesome.io/index.ts2 symbols
src/tools/capacitor-community/index.ts2 symbols
src/tools/mcp-server-setup/set_live_viewer.ts1 symbols
src/tools/coreJson/index.ts1 symbols
src/tools/capacitorjs.com/index.ts1 symbols

For agents

$ claude mcp add awesome-ionic-mcp \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page