Content
# Nexus Mods MCP (Cherry Studio) Usage Instructions
This project provides a Python-based Nexus Mods MCP Server.
## 1. Prerequisites
- Python 3.10+
- Your Nexus Mods API Key:
`https://www.nexusmods.com/users/myaccount?tab=api%20access`
## 2. Install Dependencies Using Virtual Environment (Recommended)
Run in the project root directory (Windows PowerShell):
```powershell
python -m venv .venv
.\.venv\Scripts\Activate.ps1
python -m pip install --upgrade pip
pip install -r requirements.txt
```
If you are using CMD:
```bat
.venv\Scripts\activate.bat
```
## 3. Local Direct Launch (For Debugging)
```powershell
$env:NEXUSMODS_API_KEY = "YOUR_KEY"
python nexusmods_mcp_server.py
```
Note: `python` should come from your activated `.venv`.
## 4. Configure MCP in Cherry Studio (Using Virtual Environment Python)
1. Open Cherry Studio settings, go to MCP (or Tools / MCP Servers).
2. Add a new MCP Server, name it `nexusmods`.
3. Use local command mode, example configuration as follows:
```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)"
}
}
}
}
```
Note:
- `command` please fill in the Python path in your project `.venv`.
- `args` it is recommended to use the absolute path of `nexusmods_mcp_server.py`.
- Please do not leak `NEXUSMODS_API_KEY`.
## 5. Optional Environment Variables
- `NEXUSMODS_API_KEY` (Required)
- `NEXUSMODS_USER_AGENT` (Optional)
- `NEXUSMODS_BASE_URL` (Optional, default `https://api.nexusmods.com`)
- `NEXUSMODS_TIMEOUT_SECONDS` (Optional, default `30`)
- `NEXUSMODS_MAX_RETRIES` (Optional, default `1`)
- `NEXUSMODS_RETRY_BACKOFF_SECONDS` (Optional, default `0.6`)
## 6. Main Tools
- `get_server_config`: View service running configuration (excluding sensitive information)
- `validate_api_key`: Validate 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`: General request (support custom timeout and retry)
## 7. Update API Key
Update `env.NEXUSMODS_API_KEY` in Cherry Studio's MCP configuration, save and restart the corresponding MCP Server.
