运行:ai MCP服务器
一个MCP(模型上下文协议)服务器,在多个版本和文档集(自托管、SaaS、多对映、API、遗留)中公开NVIDIA Run:ai文档和API引用。
安装(npm注册表)
推荐: 全局安装以快速启动:```bash
npm install -g runai-mcp-server
> ⚠️ **为什么全球安装?** 此软件包包括一个文档数据库。使用 `npx` 在MCP配置中,每次启动时都会重新下载包,导致初始化缓慢。全局安装可确保即时启动。
## 安装(从源代码)
1. `npm install`
1. `npm run build`
## 跑
- `npm start` (运行编译后的服务器)
- `npm run dev` (通过tsx从TypeScript源代码运行)
## 刷新文档
- `npm run scrape` (重新抓取文档并重建SQLite数据库)
- `npm run verify-urls` (验证配置的文档URL)
- 默认的抓取范围仅限于最新文档(`2.24`)for `self-hosted`, `api`, `saas`,以及 `multi-tenant`.
- 当特定页面/工具请求需要非缓存版本时,会在运行时动态获取它们。
## 发行的组建
- `npm run release:prepare`
- 运行scraper+TypeScript构建+阶段 `dist/data/runai-docs.db` 用于npm打包。
- GitHub发布工作流之前运行此命令 `npm pack`,因此已发布的包可以开箱运行。
## 配置
> **注:** 当通过npm安装时,文档数据库与软件包捆绑在一起。基本使用不需要配置。
- `RUNAI_DOCS_DB`:自定义的可选路径 `runai-docs.db` (仅当您想使用自己的抓取数据库时才需要)。
- `RUNAI_DOCS_DOCSET`:接受docset的工具的默认docset(默认值: `self-hosted`).
- `RUNAI_DOCS_VERSION`:接受版本的工具的默认版本(默认: `latest`).
- `RUNAI_DOCS_LATEST_VERSION`:在以下情况下回退数字版本 `latest` 无法解析(默认值: `2.24`).
- `RUNAI_DOCS_DOCSETS`:scraper only,逗号分隔的要包含的文档集列表(默认值: `self-hosted,api,saas,multi-tenant`).
- `RUNAI_DOCS_VERSIONS`:仅限scraper,逗号分隔的要包含的版本列表(默认值: `2.24`).
- `RUNAI_DOCS_DISCOVER_LINKS`:仅限刮刀,设置为 `0` 禁用内部链接发现(默认:启用)。
- `RUNAI_DOCS_MAX_PAGES`:仅限scraper,收集的最大页面数,包括已发现的链接(默认值: `2000`).
- `RUNAI_DOCS_MAX_LINKS_PER_PAGE`:仅限scraper,限制每页发现的链接数(默认值: `200`).
- `RUNAI_DOCS_LIVE_LOOKUP`:未缓存页面的运行时实时回退(`1` 默认启用,设置 `0` 禁用)。
- `RUNAI_DOCS_LIVE_TIMEOUT_MS`:运行时实时回退请求超时(默认值: `12000`).
## MCP 客户端安装
### OpenCode
配置位置:
- 全球的: `~/.config/opencode/opencode.json`
- 项目: `opencode.json` 在repo根目录中```json
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"runai-docs": {
"type": "local",
"command": ["runai-mcp-server"],
"enabled": true
}
}
}
克劳德桌面版
增添 claude_desktop_config.json:```json
{
"mcpServers": {
"runai-docs": {
"command": "runai-mcp-server"
}
}
}
配置位置:
- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
- 窗户: `%APPDATA%\Claude\claude_desktop_config.json`
### 光标
创建或编辑 `~/.cursor/mcp.json` (全球)或 `.cursor/mcp.json` (项目):```json
{
"mcpServers": {
"runai-docs": {
"command": "runai-mcp-server"
}
}
}
OpenAI Codex
通过CLI添加:```bash
codex mcp add runai-docs -- runai-mcp-server
或编辑 `~/.codex/config.toml`:```toml
[mcp_servers.runai-docs]
command = "runai-mcp-server"
args = []
