Consul MCP server

Consul MCP Server provides access to Consul's functionality through a standardized Model Context Protocol (MCP) interface. This server allows you to interact with Consul services, health checks, key-value store, and other Consul features through a unified API.

Features

Service Management

• List running services
• Register and deregister services
• Get service information
• List catalog services
• Get catalog service information

Health Checks

• Register health checks
• Deregister health checks
• Get health checks for services

Key-Value Store

• Get values from KV store
• List keys in KV store
• Put values in KV store
• Delete keys from KV store

Additional Features

• Sessions management (list and destroy)
• Event handling (fire and list events)
• Prepared queries (create and execute)
• Status information (leader and peers)
• Agent information (members and self details)
• System health service information

Installation

Prerequisites

• Node.js installed on your system
• Access to a Consul server

Steps to Install

1. Clone the repository:

   git clone https://github.com/kocierik/consul-mcp-server.git
   cd consul-mcp-server
   

2. Install dependencies:

   npm install
   

3. Build the project:

   npm run build
   

Automatic Installation via Smithery

You can install Consul Server for Claude Desktop automatically using Smithery:

npx -y @smithery/cli install @kocierik/consul-mcp-server --client claude

Configuration

The server can be configured using environment variables:

• CONSUL_HOST: Consul server host (default: localhost)
• CONSUL_PORT: Consul server port (default: 8500)

Usage

Starting the Server

Start the server using:

node build/index.js

The server will connect to Consul and make all functionality available through the MCP interface.

Claude Configuration

To use with Claude, add this configuration to your Claude config file:

{
    "mcpServers": {
        "consul-mcp": {
            "command": "node",
            "args": [
                "/ABSOLUTE/PATH/TO/PARENT/FOLDER/consul-mcp-server/build/index.js"
            ]
        }
    }
}

Be sure to replace the path with the absolute path to the build/index.js file on your system.

Using the MCP Inspector

To verify the server is working correctly, you can run the MCP inspector:

npm run build && npx @modelcontextprotocol/inspector node build/index.js

This will show you all available functionality and help you test the connection to your Consul server.

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 "consul-mcp" '{"command":"node","args":["/ABSOLUTE/PATH/TO/PARENT/FOLDER/consul-mcp-server/build/index.js"]}'

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": {
        "consul-mcp": {
            "command": "node",
            "args": [
                "/ABSOLUTE/PATH/TO/PARENT/FOLDER/consul-mcp-server/build/index.js"
            ]
        }
    }
}

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": {
        "consul-mcp": {
            "command": "node",
            "args": [
                "/ABSOLUTE/PATH/TO/PARENT/FOLDER/consul-mcp-server/build/index.js"
            ]
        }
    }
}

3. Restart Claude Desktop for the changes to take effect