mcp-nacos 0.1.0__tar.gz

mcp_nacos-0.1.0/.dockerignore

@@ -0,0 +1,42 @@
+# 版本控制与 CI
+.git
+.gitignore
+
+# Python 缓存与构建产物
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+build/
+dist/
+*.egg-info/
+.eggs/
+wheels/
+
+# 虚拟环境
+.venv/
+venv/
+env/
+ENV/
+.env
+
+# 测试与缓存
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# IDE / 编辑器
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# 日志
+*.log

mcp_nacos-0.1.0/.env.example

@@ -0,0 +1,20 @@
+# ===== MCP 传输与认证 =====
+# 传输协议：stdio（默认） / sse / streamable-http
+MCP_TRANSPORT=streamable-http
+# HTTP 传输监听地址与端口（stdio 模式忽略）
+MCP_HOST=0.0.0.0
+MCP_PORT=8000
+# 设置后启用 Bearer Token 认证，保护 HTTP 接口（强烈建议在生产环境配置）
+MCP_AUTH_TOKEN=change-me-to-a-strong-token
+# 日志级别：debug / info / warning / error
+MCP_LOG_LEVEL=info
+
+# ===== Nacos 连接配置 =====
+NACOS_HOST=localhost
+NACOS_API_PORT=8848
+NACOS_CONSOLE_PORT=8080
+NACOS_USERNAME=nacos
+NACOS_PASSWORD=your-password
+NACOS_NAMESPACE=public
+NACOS_VERSION=3
+NACOS_READ_ONLY=false

mcp_nacos-0.1.0/.gitignore

@@ -0,0 +1,53 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual environments
+venv/
+.venv/
+ENV/
+env/
+.env
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+.nox/
+
+# Build
+*.manifest
+*.spec
+
+# Logs
+*.log

mcp_nacos-0.1.0/Dockerfile

@@ -0,0 +1,47 @@
+# syntax=docker/dockerfile:1
+
+##########  构建阶段  ##########
+FROM python:3.12-slim AS builder
+
+WORKDIR /app
+
+# 仅复制构建所需文件，最大化利用缓存
+COPY pyproject.toml README.md ./
+COPY src ./src
+
+# 构建 wheel 并安装到独立前缀，便于拷贝到运行阶段
+RUN pip install --no-cache-dir --upgrade pip build \
+    && pip wheel --no-cache-dir --no-deps --wheel-dir /wheels . \
+    && pip install --no-cache-dir --prefix=/install .
+
+
+##########  运行阶段  ##########
+FROM python:3.12-slim AS runtime
+
+# 运行时环境变量默认值（可在 docker run / compose 中覆盖）
+ENV PYTHONUNBUFFERED=1 \
+    PYTHONDONTWRITEBYTECODE=1 \
+    MCP_TRANSPORT=streamable-http \
+    MCP_HOST=0.0.0.0 \
+    MCP_PORT=8000
+
+WORKDIR /app
+
+# 拷贝已安装的依赖与包
+COPY --from=builder /install /usr/local
+
+# 使用非 root 用户运行
+RUN useradd --create-home --uid 10001 appuser
+USER appuser
+
+EXPOSE 8000
+
+# 健康检查：HTTP 传输下 /health 免鉴权返回 200
+HEALTHCHECK --interval=30s --timeout=5s --start-period=10s --retries=3 \
+    CMD python -c "import os,urllib.request,sys; \
+port=os.getenv('MCP_PORT','8000'); \
+sys.exit(0) if os.getenv('MCP_TRANSPORT','stdio')=='stdio' else \
+sys.exit(0 if urllib.request.urlopen(f'http://127.0.0.1:{port}/health', timeout=3).status==200 else 1)"
+
+# 入口：通过控制台脚本启动，具体协议由 MCP_TRANSPORT 决定
+ENTRYPOINT ["mcp-nacos"]

mcp_nacos-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 zhouweico
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mcp_nacos-0.1.0/PKG-INFO

@@ -0,0 +1,306 @@
+Metadata-Version: 2.4
+Name: mcp-nacos
+Version: 0.1.0
+Summary: MCP Server for Nacos configuration management
+Project-URL: Homepage, https://github.com/zhouweico/mcp-nacos
+Project-URL: Repository, https://github.com/zhouweico/mcp-nacos
+Author: zhouweico
+License-Expression: MIT
+License-File: LICENSE
+Keywords: configuration,mcp,model-context-protocol,nacos
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: mcp>=1.0.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: starlette>=0.37.0
+Requires-Dist: uvicorn>=0.27.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.4.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# mcp-nacos
+
+Nacos MCP Server - 让 AI 助手能够查询和管理 Nacos 配置。
+
+支持 Nacos 1.x/2.x/3.x 版本。
+
+发布到 PyPI 后可直接 `uvx mcp-nacos` 使用；发布前可用 `uvx --from "mcp-nacos @ git+https://github.com/zhouweico/mcp-nacos" mcp-nacos` 从源码运行，或 `pipx install mcp-nacos`。容器镜像见 [GitHub Packages](https://github.com/zhouweico/mcp-nacos/pkgs/container/mcp-nacos)（`ghcr.io/zhouweico/mcp-nacos`）。
+
+## 快速开始
+
+### Claude Code
+
+在项目 `.mcp.json` 或全局 `~/.claude.json` 中添加：
+
+```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
+
+在 `~/.cursor/mcp.json` 中添加：
+
+```json
+{
+  "mcpServers": {
+    "nacos": {
+      "command": "uvx",
+      "args": ["mcp-nacos"],
+      "env": {
+        "NACOS_HOST": "localhost",
+        "NACOS_API_PORT": "8848",
+        "NACOS_CONSOLE_PORT": "8080",
+        "NACOS_NAMESPACE": "dev",
+        "NACOS_VERSION": "3",
+        "NACOS_READ_ONLY": "false"
+      }
+    }
+  }
+}
+```
+
+### OpenCode
+
+在 `~/.opencode/opencode.json` 中添加：
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "mcp": {
+    "nacos": {
+      "type": "local",
+      "command": ["uvx", "mcp-nacos"],
+      "enabled": true,
+      "environment": {
+        "NACOS_HOST": "localhost",
+        "NACOS_API_PORT": "8848",
+        "NACOS_CONSOLE_PORT": "8080",
+        "NACOS_NAMESPACE": "dev",
+        "NACOS_VERSION": "3",
+        "NACOS_READ_ONLY": "false"
+      }
+    }
+  }
+}
+```
+
+### Claude Desktop
+
+在 `claude_desktop_config.json` 中添加：
+
+```json
+{
+  "mcpServers": {
+    "nacos": {
+      "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"
+      }
+    }
+  }
+}
+```
+
+## 环境变量
+
+### 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` |
+
+## 多协议传输
+
+通过 `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 启动示例：
+
+```bash
+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 接口不鉴权，生产环境请务必配置。
+
+支持 streamable-http 的客户端配置示例：
+
+```json
+{
+  "mcpServers": {
+    "nacos": {
+      "type": "streamable-http",
+      "url": "http://your-host:8000/mcp",
+      "headers": {
+        "Authorization": "Bearer your-strong-token"
+      }
+    }
+  }
+}
+```
+
+## 容器化部署
+
+### Docker
+
+```bash
+# 构建镜像
+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
+```
+
+也可直接拉取已发布的镜像，免本地构建：
+
+```bash
+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_VERSION=3 \
+  ghcr.io/zhouweico/mcp-nacos:latest
+```
+
+### Docker Compose
+
+复制 `.env.example` 为 `.env` 并按需修改，然后：
+
+```bash
+cp .env.example .env
+docker compose up -d --build
+```
+
+`docker-compose.yml` 已内置健康检查（探测 `/health`），并以非 root 用户运行容器。
+
+## 可用工具
+
+| 工具 | 说明 |
+|------|------|
+| `nacos_get_config` | 获取配置内容 |
+| `nacos_publish_config` | 发布/更新配置（只读模式下不可用） |
+
+## 提示示例
+
+配置好后，你可以这样和 AI 对话：
+
+**查询配置：**
+
+```
+帮我获取 Nacos 中 dataId 为 "application.yaml" 的配置
+```
+
+```
+查看 nacos 里 user-service.yml 的配置内容，namespace 是 dev
+```
+
+```
+获取 gateway 的配置，分组是 PROD_GROUP
+```
+
+**发布配置：**
+
+```
+把下面这段配置发布到 Nacos，dataId 是 "redis.yaml"：
+server:
+  port: 6379
+```
+
+```
+更新 user-service 的配置，把数据库端口改成 3307
+```
+
+## 只读模式
+
+设置 `NACOS_READ_ONLY=true` 可以禁用发布功能，只允许查询配置。适合生产环境使用。
+
+```json
+{
+  "env": {
+    "NACOS_READ_ONLY": "true"
+  }
+}
+```
+
+## License
+
+MIT