Composer Kit MCP Server

by celo-org

162 downloads Not rated yet MIT license
GitHub

About

A MCP server for accessing Composer Kit UI components documentation, examples, and usage information

Details

License
MIT license

Explore

- Complete component API reference with prop documentation
- Real‑world usage examples for every component
- Semantic search and category filtering for components
- Template management for Minipay, Valora, Social Connect
- CLI commands and project creation for Celo Composer
- Step‑by‑step integration and deployment guides

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Composer Kit MCP Server
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

1. Clone the repository:

git clone https://github.com/celo-org/composer-kit-mcp
cd composer-kit-mcp

2. Install dependencies:

pip install -e .

pip install pipx

pipx install composer-kit-mcp


python -m venv composer-kit-mcp-env
source composer-kit-mcp-env/bin/activate  # On Windows: composer-kit-mcp-env\Scripts\activate

pip install composer-kit-mcp

bash

6. get_installation_guide

- Get installation instructions for Composer Kit, including setup steps and configuration
- Parameters: package_manager (optional: 'npm', 'yarn', 'pnpm', 'bun')

7. get_components_by_category
- Get all components in a specific category
- Parameters: category (e.g., 'Core Components', 'Wallet Integration', 'Payment & Transactions')

pytest

8. list_celo_composer_templates

- List all available Celo Composer templates with their descriptions, use cases, and features
- No parameters required

9. get_celo_composer_template

- Get detailed information about a specific Celo Composer template
- Parameters: template_name (e.g., 'Minipay', 'Valora', 'Social Connect')

10. list_celo_composer_frameworks

- List supported frameworks in Celo Composer (React/Next.js, Hardhat)
- No parameters required

11. get_celo_composer_commands

- Get available Celo Composer CLI commands with flags and usage examples
- No parameters required

12. get_celo_composer_guide

- Get step-by-step guides for various Celo Composer tasks
- Parameters: guide_type ('quick-start', 'smart-contract-deployment', 'local-development', 'ui-components', 'deployment')

13. get_integration_guide

- Get a comprehensive guide on integrating Composer Kit with Celo Composer projects
- No parameters required

14. create_celo_composer_project
- Generate the complete command to create a new Celo Composer project
- Parameters: project_name, owner, template, include_hardhat (optional, defaults to true)
- Returns: Complete CLI command with next steps and template information

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "composer kit mcp server": {
            "composer-kit-mcp": {
                "command": "python",
                "args": [
                    "-m",
                    "venv",
                    "composer-kit-mcp-env"
                ]
            }
        }
    }
}

McpServers

{
    "composer-kit-mcp": {
        "command": "python",
        "args": [
            "-m",
            "venv",
            "composer-kit-mcp-env"
        ]
    }
}

A Model Context Protocol (MCP) server for accessing Composer Kit UI components documentation, examples, and usage information. This server provides comprehensive access to the Composer Kit React component library designed for building web3 applications on the Celo blockchain.

Installation

1. Clone the repository:

git clone https://github.com/celo-org/composer-kit-mcp
cd composer-kit-mcp

2. Install dependencies:

pip install -e .

MCP Client Setup

Setting up in Cursor

1. Install the MCP server (if not already done):

   pip install composer-kit-mcp
   

2. Configure Cursor by adding the MCP server to your Cursor settings:

- Open Cursor Settings (Cmd/Ctrl + ,)
- Navigate to "Features" → "Model Context Protocol"
- Add a new MCP server with the following configuration:

   {
     "mcpServers": {
       "composer-kit-mcp": {
         "command": "uvx",
         "args": ["composer-kit-mcp"]
       }
     }
   }
   

3. Restart Cursor to load the MCP server

4. Verify the setup by asking Cursor about Composer Kit components:
- "What Composer Kit components are available?"
- "Show me how to use the Wallet component"
- "Search for payment-related components"

Setting up in Claude Desktop

1. Install the MCP server (if not already done):

   pip install composer-kit-mcp
   

2. Locate your Claude Desktop config file:

- macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
- Windows: %APPDATA%\Claude\claude_desktop_config.json

3. Edit the config file to add the MCP server:

   {
     "mcpServers": {
       "composer-kit-mcp": {
         "command": "uvx",
         "args": ["composer-kit-mcp"]
       }
     }
   }
   

If the file doesn't exist, create it with the above content.

4. Restart Claude Desktop to load the MCP server

5. Verify the setup by asking Claude about Composer Kit:
- Look for the 🔌 icon in the chat interface indicating MCP tools are available
- Ask: "What Composer Kit components can you help me with?"
- Try: "Show me examples of using the Payment component"

Alternative Installation Methods

Using pipx (Recommended for isolation)

```bash

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.