CO

consul-mcp

Created 6 months ago

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

development documentation public

What is consul-mcp?

A consul MCP server for service management, health check and Key-Value Store

Documentation

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

Server Config

{
  "mcpServers": {
    "consul-mcp-server": {
      "command": "npx",
      "args": [
        "consul-mcp"
      ]
    }
  }
}

Links & Status

Repository: github.com
Hosted: No
Global: No
Official: No

Project Info

Hosted Featured
Created At: May 23, 2025
Updated At: Aug 07, 2025
Author: kocierik
Category: community
License: MIT
Tags:
development documentation public