Consul

🚀 Consul MCP Server

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

✨ Features

This server provides access to the following Consul features:

Service Management

• List running services
• Register and deregister services
• Get service information
• List services in the catalog
• Get information about services in the catalog

Health Checks

• Register health checks
• Deregister health checks
• Get the health check status of a service

Key-Value Storage

• Get a value from the KV store
• List keys in the KV store
• Write a value to the KV store
• Delete a key from the KV store

Session Management

• List sessions
• Destroy sessions

Events

• Publish events
• List events

Prepared Queries

• Create a prepared query
• Execute a prepared query

Status Information

• Get the current leader
• Get the current peers

Agent Information

• Get agent members
• Get information about the agent itself

System Information

• Get information about system health services

📦 Installation

The server can be configured via environment variables:

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

💻 Usage Examples

Basic Usage

1. Start the server:

node build/index.js

2. The server will connect to Consul and provide all features through the MCP interface.

🔧 Development Steps

1. Install dependencies:

npm install

2. Build the project:

npm run build

3. Run the inspection tool:

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

Claude Configuration

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

📄 License

MIT