READMEmain

pd-mcp-ctl

Name: pd-mcp-ctl
Author: JmPotato

Connects the Model Context Protocol (MCP) with PD Control, enabling LLMs to interact with and manage TiKV cluster efficiently and intelligently.

Prerequisites

Deno
Access to a TiKV cluster with PD Control

Usage

Clone the repository:

git clone https://github.com/JmPotato/pd-mcp-ctl.git
cd pd-mcp-ctl

Compile:

deno run build
./dist/pd-mcp-ctl --help

Take Claude Desktop as an example, edit your claude_desktop_config.json like:

{
    "mcpServers": {
        "pd-mcp-ctl": {
            "command": "{PATH_TO_PD_MCP_CTL_REPO}/dist/pd-mcp-ctl",
            "args": [
                "stdio"
            ],
            "env": {
                "PD_ENDPOINT": "http://127.0.0.1:2379",
                "PD_CTL_PATH": "{PATH_TO_PD_CTL_BINARY}"
            }
        }
    }
}

More details can be found in Model Context Protocol Docs.

Implemented MCP Tools

Tool Name	Description
execute-command	Execute any pd-ctl command
get-cluster-info	Get the current cluster info
get-config-info	Get the current config info
get-health-info	Get the current health info
get-region-info	Get the current region info
get-scheduler-info	Get the current scheduler info
get-store-info	Get the current store info

License

MIT License - see the LICENSE file for details.