Symbol Blockchain MCP server

The Symbol Blockchain MCP Server provides a convenient interface that allows you to access the Symbol blockchain's REST API as MCP (Model Context Protocol) tools. This server acts as a bridge between your applications and the Symbol blockchain, making it easier to integrate blockchain functionality.

Installation

To use the Symbol Blockchain MCP Server, you need to have Node.js installed on your system. Follow these steps to set up the server:

Prerequisites

• Node.js (latest LTS version recommended)
• npm or yarn package manager

Install the Server

You can install and run the Symbol Blockchain MCP Server directly using npx:

npx -y tsx symbol-mcp-server

Alternatively, you can clone the repository and run it locally:

# Clone the repository
git clone https://github.com/yourusername/symbol-mcp-server.git

# Navigate to the project directory
cd symbol-mcp-server

# Install dependencies
npm install

Configuration

To integrate the Symbol Blockchain MCP Server with your project, you need to add it to your MCP configuration. Create or update your configuration file with the following settings:

{
  "mcpServers": {
    "symbol": {
      "command": "npx",
      "args": [
        "-y",
        "tsx",
        "/path/to/your/mcp/symbol-mcp-server/src/index.ts"
      ]
    }
  }
}

Make sure to replace /path/to/your/mcp/symbol-mcp-server/src/index.ts with the actual path to the server's index.ts file on your system.

Using the MCP Server

Once configured, you can use the Symbol Blockchain MCP Server to interact with the Symbol blockchain through the MCP protocol. The server will handle the communication between your application and the Symbol blockchain's REST API.

Example Usage

Your application can now make requests to the Symbol blockchain through the MCP protocol. The specific commands and operations available will depend on the Symbol blockchain API functionality.

The server will automatically translate MCP protocol requests into appropriate REST API calls to the Symbol blockchain network, and return the responses in the format expected by your MCP client.

Troubleshooting

If you encounter issues with the server:

• Ensure Node.js is properly installed and updated
• Verify that the path to the server in your configuration is correct
• Check that you have network connectivity to the Symbol blockchain nodes
• Review any error messages in the server logs for specific issues

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "symbol" '{"command":"npx","args":["-y","tsx","/path/to/your/mcp/symbol-mcp-server/src/index.ts"]}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "symbol": {
            "command": "npx",
            "args": [
                "-y",
                "tsx",
                "/path/to/your/mcp/symbol-mcp-server/src/index.ts"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json
• Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

{
    "mcpServers": {
        "symbol": {
            "command": "npx",
            "args": [
                "-y",
                "tsx",
                "/path/to/your/mcp/symbol-mcp-server/src/index.ts"
            ]
        }
    }
}

3. Restart Claude Desktop for the changes to take effect