diff --git a/README.md b/README.md index 2b0929f..6e162d9 100644 --- a/README.md +++ b/README.md @@ -170,6 +170,8 @@ git clone https://github.com/Tencent/WeKnora ``` #### 2️⃣ Configure MCP Server +> It is recommended to directly refer to the [MCP Configuration Guide](./mcp-server/MCP_CONFIG.md) for configuration. + Configure the MCP client to connect to the server: ```json { diff --git a/README_CN.md b/README_CN.md index 5903a72..24dc3ea 100644 --- a/README_CN.md +++ b/README_CN.md @@ -167,6 +167,8 @@ WeKnora 作为[微信对话开放平台](https://chatbot.weixin.qq.com)的核心 git clone https://github.com/Tencent/WeKnora ``` #### 2️⃣配置MCP服务器 +> 推荐直接参考 [MCP配置说明](./mcp-server/MCP_CONFIG.md) 进行配置。 + mcp客户端配置服务器 ```json { diff --git a/README_JA.md b/README_JA.md index b7cdfc4..6e53657 100644 --- a/README_JA.md +++ b/README_JA.md @@ -168,6 +168,8 @@ WeKnoraは[WeChat対話オープンプラットフォーム](https://chatbot.wei git clone https://github.com/Tencent/WeKnora ``` #### 2️⃣MCPサーバーの設定 +> 設定には直接 [MCP設定説明](./mcp-server/MCP_CONFIG.md) を参照することをお勧めします。 + MCPクライアントでサーバーを設定 ```json { diff --git a/mcp-server/CHANGELOG.md b/mcp-server/CHANGELOG.md index aed790f..03c7915 100644 --- a/mcp-server/CHANGELOG.md +++ b/mcp-server/CHANGELOG.md @@ -88,11 +88,11 @@ WeKnoraMCP/ - 完整的测试覆盖 ### 依赖 -- Python 3.8+ +- Python 3.10+ - mcp >= 1.0.0 - requests >= 2.31.0 ### 兼容性 - 支持 Windows、macOS、Linux -- 支持 Python 3.8-3.12 +- 支持 Python 3.10-3.12 - 兼容现代 Python 包管理工具 \ No newline at end of file diff --git a/mcp-server/INSTALL.md b/mcp-server/INSTALL.md index 090ecce..d17e5e6 100644 --- a/mcp-server/INSTALL.md +++ b/mcp-server/INSTALL.md @@ -103,7 +103,7 @@ python main.py --check-only ### 1. 导入错误 如果遇到 `ImportError`,请确保: - 已安装所有依赖:`pip install -r requirements.txt` -- Python 版本兼容(推荐 3.8+) +- Python 版本兼容(推荐 3.10+) - 没有文件名冲突 ### 2. 连接错误 diff --git a/mcp-server/MCP_CONFIG.md b/mcp-server/MCP_CONFIG.md new file mode 100644 index 0000000..8c095a2 --- /dev/null +++ b/mcp-server/MCP_CONFIG.md @@ -0,0 +1,114 @@ +# 使用 uv 运行 WeKnora MCP 服务器 + +> 更推荐使用`uv`来运行基于python的MCP服务。 + +## 1. 安装 uv + +```bash +# macOS/Linux +curl -LsSf https://astral.sh/uv/install.sh | sh + +# 或使用 Homebrew (macOS) +brew install uv + +# Windows +powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex" +``` + +## 2. MCP 客户端配置 + +### Claude Desktop 配置 + +在 Claude Desktop 设置中添加: + +```json +{ + "mcpServers": { + "weknora": { + "args": [ + "--directory", + "/path/WeKnora/mcp-server", + "run", + "run_server.py" + ], + "command": "uv", + "env": { + "WEKNORA_API_KEY": "your_api_key_here", + "WEKNORA_BASE_URL": "http://localhost:8080/api/v1" + } + } + } +} +``` + +### Cursor 配置 + +在 Cursor 中,编辑 MCP 配置文件 (通常在 `~/.cursor/mcp-config.json`): + +```json +{ + "mcpServers": { + "weknora": { + "command": "uv", + "args": [ + "--directory", + "/path/WeKnora/mcp-server", + "run", + "run_server.py" + ], + "env": { + "WEKNORA_API_KEY": "your_api_key_here", + "WEKNORA_BASE_URL": "http://localhost:8080/api/v1" + } + } + } +} +``` + +### KiloCode 配置 + +对于 KiloCode 或其他支持 MCP 的编辑器,配置如下: + +```json +{ + "mcpServers": { + "weknora": { + "command": "uv", + "args": [ + "--directory", + "/path/WeKnora/mcp-server", + "run", + "run_server.py" + ], + "env": { + "WEKNORA_API_KEY": "your_api_key_here", + "WEKNORA_BASE_URL": "http://localhost:8080/api/v1" + } + } + } +} +``` + +### 其他 MCP 客户端 + +对于一般 MCP 客户端配置: + +```json +{ + "mcpServers": { + "weknora": { + "command": "uv", + "args": [ + "--directory", + "/path/WeKnora/mcp-server", + "run", + "run_server.py" + ], + "env": { + "WEKNORA_API_KEY": "your_api_key_here", + "WEKNORA_BASE_URL": "http://localhost:8080/api/v1" + } + } + } +} +``` diff --git a/mcp-server/PROJECT_SUMMARY.md b/mcp-server/PROJECT_SUMMARY.md index 37b307e..8dd6168 100644 --- a/mcp-server/PROJECT_SUMMARY.md +++ b/mcp-server/PROJECT_SUMMARY.md @@ -184,9 +184,7 @@ WeKnora MCP Server 模组测试 ## 🔍 兼容性 ### Python 版本 -- ✅ Python 3.8+ -- ✅ Python 3.9 -- ✅ Python 3.10 +- ✅ Python 3.10+ - ✅ Python 3.11 - ✅ Python 3.12 @@ -275,5 +273,5 @@ python test_module.py # 运行测试 **项目状态**: ✅ 完成并可投入使用 **项目仓库**: https://github.com/NannaOlympicBroadcast/WeKnoraMCP -**最后更新**: 2024年1月 +**最后更新**: 2025年10月 **版本**: 1.0.0 \ No newline at end of file diff --git a/mcp-server/README.md b/mcp-server/README.md index cf98266..d512f94 100644 --- a/mcp-server/README.md +++ b/mcp-server/README.md @@ -4,6 +4,8 @@ ## 快速开始 +> 推荐直接参考 [MCP配置说明](./MCP_CONFIG.md),无需进行以下操作。 + ### 1. 安装依赖 ```bash pip install -r requirements.txt @@ -133,5 +135,5 @@ python test_module.py 如果遇到导入错误,请确保: 1. 已安装所有必需的依赖包 -2. Python 版本兼容(推荐 3.8+) +2. Python 版本兼容(推荐 3.10+) 3. 没有文件名冲突(避免使用 `mcp.py` 作为文件名) \ No newline at end of file diff --git a/mcp-server/pyproject.toml b/mcp-server/pyproject.toml index 343a57e..f4d1220 100644 --- a/mcp-server/pyproject.toml +++ b/mcp-server/pyproject.toml @@ -21,8 +21,6 @@ classifiers = [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.8", - "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.12", @@ -30,7 +28,7 @@ classifiers = [ "Topic :: Internet :: WWW/HTTP :: HTTP Servers", "Topic :: Scientific/Engineering :: Artificial Intelligence", ] -requires-python = ">=3.8" +requires-python = ">=3.10" dependencies = [ "mcp>=1.0.0", "requests>=2.31.0", diff --git a/mcp-server/setup.py b/mcp-server/setup.py index cca9860..95e2bfb 100644 --- a/mcp-server/setup.py +++ b/mcp-server/setup.py @@ -38,8 +38,6 @@ setup( "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.8", - "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.12", @@ -47,7 +45,7 @@ setup( "Topic :: Internet :: WWW/HTTP :: HTTP Servers", "Topic :: Scientific/Engineering :: Artificial Intelligence", ], - python_requires=">=3.8", + python_requires=">=3.10", install_requires=read_requirements(), entry_points={ "console_scripts": [