内容
# Nexus Mods MCP（Cherry Studio）使用说明
本项目提供一个基于 Python 的 Nexus Mods MCP Server。
## 1. 前置条件
- Python 3.10+
- 你的 Nexus Mods API Key：
`https://www.nexusmods.com/users/myaccount?tab=api%20access`
## 2. 使用虚拟环境安装依赖（推荐）
在项目根目录执行（Windows PowerShell）：
```powershell
python -m venv .venv
.\.venv\Scripts\Activate.ps1
python -m pip install --upgrade pip
pip install -r requirements.txt
```
如果你使用 CMD：
```bat
.venv\Scripts\activate.bat
```
## 3. 本地直接启动（调试用）
```powershell
$env:NEXUSMODS_API_KEY = "YOUR_KEY"
python nexusmods_mcp_server.py
```
说明：`python` 应来自你已激活的 `.venv`。
## 4. 在 Cherry Studio 中配置 MCP（使用虚拟环境 Python）
1. 打开 Cherry Studio 设置，进入 MCP（或 Tools / MCP Servers）。
2. 新增一个 MCP Server，命名为 `nexusmods`。
3. 使用本地命令方式，示例配置如下：
```json
{
"mcpServers": {
"nexusmods": {
"command": "E:/Github/mcp/.venv/Scripts/python.exe",
"args": ["E:/Github/mcp/nexusmods_mcp_server.py"],
"env": {
"NEXUSMODS_API_KEY": "YOUR_KEY",
"NEXUSMODS_USER_AGENT": "NexusModsMCP/1.1 (Windows; MCP)"
}
}
}
}
```
说明：
- `command` 请填写你项目 `.venv` 中的 Python 路径。
- `args` 建议使用 `nexusmods_mcp_server.py` 的绝对路径。
- 请不要泄露 `NEXUSMODS_API_KEY`。
## 5. 可选环境变量
- `NEXUSMODS_API_KEY`（必填）
- `NEXUSMODS_USER_AGENT`（可选）
- `NEXUSMODS_BASE_URL`（可选，默认 `https://api.nexusmods.com`）
- `NEXUSMODS_TIMEOUT_SECONDS`（可选，默认 `30`）
- `NEXUSMODS_MAX_RETRIES`（可选，默认 `1`）
- `NEXUSMODS_RETRY_BACKOFF_SECONDS`（可选，默认 `0.6`）
## 6. 主要工具
- `get_server_config`：查看服务运行配置（不含敏感信息）
- `validate_api_key`：校验 API Key
- `list_games` / `get_game`
- `list_latest_added_mods` / `list_latest_updated_mods` / `list_trending_mods`
- `get_mod` / `get_mod_changelogs`
- `list_mod_files` / `get_mod_file` / `get_mod_file_download_link`
- `md5_search_mod`
- `nexusmods_request`：通用请求（支持自定义超时与重试）
## 7. 更新 API Key
在 Cherry Studio 的 MCP 配置中更新 `env.NEXUSMODS_API_KEY`，保存后重启对应 MCP Server。
