Skip to main content

MCP Server for Nacos configuration management

Project description

mcp-nacos

Nacos MCP Server - 让 AI 助手能够查询和管理 Nacos 配置。

支持 Nacos 1.x / 2.x / 3.x 版本,自动适配对应客户端。

特性

  • 多协议传输stdio(默认)、ssestreamable-http,一套代码适配本地与远程场景
  • 接口认证:HTTP 传输支持 Bearer Token 保护,未授权请求返回 401
  • Nacos 兼容:自动适配 v1 / v2 / v3,无需改动配置结构
  • 灵活部署uvx 免安装运行、Docker 公开镜像即拉即用、或本地构建

快速开始

MCP 客户端(stdio,本地)

以 Claude Code 为例,在项目 .mcp.json 或全局 ~/.claude.json 中添加:

{
  "mcpServers": {
    "nacos": {
      "type": "stdio",
      "command": "uvx",
      "args": ["mcp-nacos"],
      "env": {
        "NACOS_HOST": "localhost",
        "NACOS_API_PORT": "8848",
        "NACOS_CONSOLE_PORT": "8080",
        "NACOS_USERNAME": "nacos",
        "NACOS_PASSWORD": "your-password",
        "NACOS_NAMESPACE": "dev",
        "NACOS_VERSION": "3",
        "NACOS_READ_ONLY": "false"
      }
    }
  }
}

Cursor、OpenCode、Claude Desktop 等客户端的配置格式相同,核心均为 command: uvx + args: ["mcp-nacos"],按各客户端语法填入 NACOS_* 环境变量即可。

Docker(公开镜像,免构建)

已发布公开镜像 ghcr.io/zhouweico/mcp-nacos:latest,无需本地构建。下面以 Claude Code 为例,说明如何用 docker 命令运行并配置 mcp-nacos。

方式一:stdio(由客户端拉起容器,适合本地集成)

在 Claude Code 的 .mcp.json 中直接用 docker 作为启动命令,客户端会以 stdio 管道与容器内服务通信:

{
  "mcpServers": {
    "nacos": {
      "type": "stdio",
      "command": "docker",
      "args": ["run", "-i", "--rm", "ghcr.io/zhouweico/mcp-nacos:latest"],
      "env": {
        "NACOS_HOST": "your-nacos-host",
        "NACOS_API_PORT": "8848",
        "NACOS_CONSOLE_PORT": "8080",
        "NACOS_USERNAME": "nacos",
        "NACOS_PASSWORD": "your-password",
        "NACOS_NAMESPACE": "dev",
        "NACOS_VERSION": "3"
      }
    }
  }
}

必须带 -i(保持 stdin 管道),否则容器内的 stdio 服务无法与客户端通信。

方式二:HTTP + 认证(容器独立运行,客户端远程连接,适合多客户端共享)

先启动容器:

docker run -d -p 8000:8000 \
  -e MCP_TRANSPORT=streamable-http \
  -e MCP_AUTH_TOKEN=your-strong-token \
  -e NACOS_HOST=your-nacos-host \
  -e NACOS_VERSION=3 \
  ghcr.io/zhouweico/mcp-nacos:latest

再在 Claude Code 的 .mcp.json 中通过 HTTP 连接:

{
  "mcpServers": {
    "nacos": {
      "type": "streamable-http",
      "url": "http://localhost:8000/mcp",
      "headers": {
        "Authorization": "Bearer your-strong-token"
      }
    }
  }
}

可用工具

工具 说明
nacos_get_config 获取配置内容
nacos_publish_config 发布/更新配置(只读模式下不可用)

配置

环境变量

MCP 传输与认证

变量 说明 默认值
MCP_TRANSPORT 传输协议:stdio / sse / streamable-http stdio
MCP_HOST HTTP 传输监听地址(stdio 忽略) 0.0.0.0
MCP_PORT HTTP 传输监听端口(stdio 忽略) 8000
MCP_AUTH_TOKEN 设置后启用 Bearer Token 认证,保护 HTTP 接口 -(不鉴权)
MCP_LOG_LEVEL 日志级别:debug/info/warning/error info

Nacos 连接

变量 说明 默认值
NACOS_HOST Nacos 服务地址 localhost
NACOS_PORT API 端口(仅 v1/v2 使用,v1/v2 必填) 8848
NACOS_API_PORT API 端口(用于登录,仅 v3 使用,v3 必填) 8848
NACOS_CONSOLE_PORT Console 端口(用于配置操作,仅 v3 使用,v3 必填) 8080
NACOS_USERNAME 用户名(可选) -
NACOS_PASSWORD 密码(可选) -
NACOS_NAMESPACE 默认命名空间 ID(当 NACOS_VERSION=1 时表示 Nacos 的命名空间 ID 字段) public
NACOS_VERSION Nacos 版本(1/2/3),默认 3 3
NACOS_READ_ONLY 只读模式,禁用发布功能(适合生产环境) false

只读模式

设置 NACOS_READ_ONLY=true 可禁用发布功能,仅允许查询配置,适合生产环境使用。在客户端配置的环境变量中加入:

{
  "env": {
    "NACOS_READ_ONLY": "true"
  }
}

多协议传输

通过 MCP_TRANSPORT 选择传输协议:

  • stdio(默认):标准输入输出,适合 Claude Code、Cursor 等本地 AI 客户端集成。
  • sse:Server-Sent Events,HTTP 传输,端点 http://<host>:<port>/sse
  • streamable-http:Streamable HTTP,端点 http://<host>:<port>/mcp

streamable-http 启动示例:

MCP_TRANSPORT=streamable-http \
MCP_HOST=0.0.0.0 MCP_PORT=8000 \
MCP_AUTH_TOKEN=your-strong-token \
mcp-nacos

接口认证

设置 MCP_AUTH_TOKEN 后,所有 HTTP 请求必须携带正确 Token,否则返回 401

Authorization: Bearer <MCP_AUTH_TOKEN>

也兼容 X-Auth-Token / X-MCP-Token 请求头。健康检查端点 GET /health 免鉴权,返回 {"status":"ok"},用于容器探活。

stdio 传输为本地进程通信,不涉及网络,无需也不会进行 Token 认证。未设置 MCP_AUTH_TOKEN 时 HTTP 接口不鉴权,生产环境请务必配置。

容器化部署

本地构建(Docker)

如需本地构建或定制镜像:

# 构建镜像
docker build -t mcp-nacos:latest .

# 以 streamable-http 运行并启用认证
docker run -d --name mcp-nacos -p 8000:8000 \
  -e MCP_TRANSPORT=streamable-http \
  -e MCP_AUTH_TOKEN=your-strong-token \
  -e NACOS_HOST=your-nacos-host \
  -e NACOS_API_PORT=8848 \
  -e NACOS_CONSOLE_PORT=8080 \
  -e NACOS_USERNAME=nacos \
  -e NACOS_PASSWORD=your-password \
  -e NACOS_NAMESPACE=public \
  -e NACOS_VERSION=3 \
  mcp-nacos:latest

直接拉取已发布的公开镜像、免本地构建的用法见 快速开始 → Docker

Docker Compose

复制 .env.example.env 并按需修改,然后:

cp .env.example .env
docker compose up -d

docker-compose.yml 已内置 build(基于本地 Dockerfile 构建并标记为 mcp-nacos:latest)和健康检查(探测 /health),以非 root 用户运行,适合本地开发部署。

若想直接运行已发布的公开镜像、跳过本地构建,可将 docker-compose.yml 中的 build: 段删除,仅保留 image: ghcr.io/zhouweico/mcp-nacos:latest

使用场景示例

配置好后,你可以这样和 AI 对话:

查询配置:

帮我获取 Nacos 中 dataId 为 "application.yaml" 的配置
查看 nacos 里 user-service.yml 的配置内容,namespace 是 dev
获取 gateway 的配置,分组是 PROD_GROUP

发布配置:

把下面这段配置发布到 Nacos,dataId 是 "redis.yaml":
server:
  port: 6379
更新 user-service 的配置,把数据库端口改成 3307

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_nacos-0.1.2.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_nacos-0.1.2-py3-none-any.whl (16.8 kB view details)

Uploaded Python 3

File details

Details for the file mcp_nacos-0.1.2.tar.gz.

File metadata

  • Download URL: mcp_nacos-0.1.2.tar.gz
  • Upload date:
  • Size: 13.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for mcp_nacos-0.1.2.tar.gz
Algorithm Hash digest
SHA256 9c38625a9d3e7c2a596c0f1c5d684b335ca35a2a567ba587ed6811f061492f6c
MD5 56d45f179c38db680946fc31ede7c87c
BLAKE2b-256 580c7839098c0304b1c9461e00dd883471d5575ab882dadaf1f88ef2327d506c

See more details on using hashes here.

File details

Details for the file mcp_nacos-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: mcp_nacos-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 16.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for mcp_nacos-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 efd303b6f30d68c120f9f95e6c28b33a78d1b3d4a929633c68dbe89e6d84c303
MD5 a72a018cf07490e6bfff555787a79006
BLAKE2b-256 f4b97e94681cbf2f5452d85cef50048b90726851eed830ad7f76bc18ee7d46d1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page