Consul MCP Server

What is Consul MCP Server about?

Enables interaction with a Consul cluster through a standardized MCP interface, exposing service management, health checks, KV operations, sessions, events, prepared queries, status, agent, and system information.

How to use Consul MCP Server?

1. Install the package (preferably via npx):

   npx -y @kocierik/consul-mcp-server
   

2. Ensure a Consul instance is reachable (default localhost:8500).
3. Start the server using the MCP configuration or directly run the built binary:

   node build/index.js
   

4. From a client that supports MCP, invoke the exposed methods to interact with Consul.

Key Features of Consul MCP Server

• Service Management: List, register, deregister services; retrieve service and catalog details.
• Health Checks: Register, deregister, and query health checks for services.
• Key‑Value Store: Get, list, put, and delete KV entries.
• Sessions: List and destroy sessions.
• Events: Fire and list Consul events.
• Prepared Queries: Create and execute prepared queries.
• Status: Query current leader and peer list.
• Agent: Retrieve agent members and self‑information.
• System: Access system health service data.

Use Cases of Consul MCP Server

• Integrating Consul operations into AI assistants or automated workflows that communicate via MCP.
• Building custom dashboards or monitoring tools that need a unified protocol to query Consul.
• Enabling serverless functions or micro‑services to manage Consul resources without direct SDK dependencies.
• Automating deployment pipelines that require service registration or KV updates through a standard interface.

FAQ from the Consul MCP Server

Q: Do I need to build the project before running it? A: Yes. Install dependencies with npm install and compile using npm run build. The entry point is build/index.js.

Q: Which environment variables configure the connection to Consul? A: CONSUL_HOST (default localhost) and CONSUL_PORT (default 8500).

Q: Can I run the server without building it first? A: If the package publishes a ready‑to‑run binary, npx -y @kocierik/consul-mcp-server will execute it directly.

Q: How do I integrate this server with Claude or other MCP clients? A: Provide a MCP server configuration referencing the command and arguments (see the serverConfig section below).

Q: Is the project open source? A: Yes, it is released under the MIT license.

Consul MCP Server 🚀

A Model Context Protocol (MCP) server that provides access to Consul's functionality through a standardized interface.

Features

The server provides access to the following Consul functionality:

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

Sessions

• List sessions
• Destroy sessions

Events

• Fire events
• List events

Prepared Queries

• Create prepared queries
• Execute prepared queries

Status

• Get current leader
• Get current peers

Agent

• Get agent members
• Get agent self information

System

• Get system health service information

Configuration

The server can be configured using environment variables:

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

Usage

1. Start the server:

node build/index.js

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

Development

1. Install dependencies:

npm install

2. Build the project:

npm run build

3. Run inspector:

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

Claude config

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

Installing via Smithery

To install Consul Server for Claude Desktop automatically via Smithery:

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

License

MIT