For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /mcp-install.md.

MCP 安装说明(给 AI Agent)

你是安装助手。目标:把 Minecraft Script API 中文文档 MCP(sapi-docs) 安装到用户当前的 AI 客户端,使下列工具可用:search_docs / get_page / list_modules / list_symbols / get_llms_index / get_symbol / search_by_tag / get_examples / get_versions / resolve_versions / init_script_project

不要向用户推销。按下列步骤直接改配置并验证。

决策树(必须遵守)

  1. 优先远程(Streamable HTTP)
    URL:https://sapi.dogelake.cn/mcp
  2. 若出现以下任一情况,立即回退本地 npm(stdio)
    • 远程探测失败(超时、DNS、非 2xx、TLS 错误)
    • 客户端不支持 url 型 MCP,只支持 command/args
    • 用户明确要求离线/本地
  3. 回退命令:npx -y sapi-docs-mcp(需本机 Node.js ≥ 20)

远程探测(可选,有网络时执行):

curl -sS -o /dev/null -w "%{http_code}" -X POST "https://sapi.dogelake.cn/mcp" -H "Content-Type: application/json" -H "Accept: application/json, text/event-stream" -d "{\"jsonrpc\":\"2.0\",\"id\":1,\"method\":\"initialize\",\"params\":{\"protocolVersion\":\"2024-11-05\",\"capabilities\":{},\"clientInfo\":{\"name\":\"probe\",\"version\":\"0.0.0\"}}}"

能返回 HTTP 2xx/4xx(有 MCP 响应体)即可视为端点可达;完全连不上再走 npm

配置片段

把下列片段合并进客户端的 MCP 配置(保留用户已有的其他 server)。

A. 远程(优先)

{
  "mcpServers": {
    "sapi-docs": {
      "url": "https://sapi.dogelake.cn/mcp"
    }
  }
}

B. 本地 npm(回退)

{
  "mcpServers": {
    "sapi-docs": {
      "command": "npx",
      "args": ["-y", "sapi-docs-mcp"]
    }
  }
}

各客户端文件位置

客户端配置文件
Cursor项目 .cursor/mcp.json 或用户目录 ~/.cursor/mcp.json(Windows:%USERPROFILE%\.cursor\mcp.json
Claude DesktopmacOS:~/Library/Application Support/Claude/claude_desktop_config.json;Windows:%APPDATA%\Claude\claude_desktop_config.json
VS Code / Copilot用户或工作区 MCP 配置(常见 .vscode/mcp.json,字段可能为 servers;按客户端文档把 urlcommand 写进去)
其他 MCP 客户端使用标准字段:url command + args

若客户端 schema 使用 servers 而非 mcpServers,保持相同 server 名 sapi-docs 与同等 url/command 内容即可。

Cursor 一键链接(人类可选)

  • 远程:cursor://anysphere.cursor-deeplink/mcp/install?name=sapi-docs&config=eyJ1cmwiOiJodHRwczovL3NhcGkuZG9nZWxha2UuY24vbWNwIn0=
  • 本地:cursor://anysphere.cursor-deeplink/mcp/install?name=sapi-docs&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsInNhcGktZG9jcy1tY3AiXX0=

主路径仍是改配置文件;deeplink 仅作快捷方式。

安装后验证

  1. 重新加载 MCP / 重启客户端(若需要)。
  2. 确认工具列表含:search_docsget_pagelist_moduleslist_symbolsget_llms_indexget_symbolsearch_by_tagget_examplesget_versionsresolve_versionsinit_script_project
  3. 冒烟调用:resolve_versions,参数 gameVersion: "1.26.42", track: "stable";再 get_symbol,参数 name: "Player", module: "server"

工具说明(装好后如何用)

工具用途
search_docs按关键词搜索 API 文档
get_page按路径取 Markdown 全文
list_modules列出模块
list_symbols列出模块内符号与路径
get_llms_index读取 llms 索引摘要或某模块段落
get_symbol结构化签名 / 成员 / 权限 / 标签 / 实验性
search_by_tag按领域标签列符号(event、player…)
get_examples官方示例代码
get_versions文档站锁定的包版本
resolve_versions按游戏版本解析推荐包版本与 min_engine
init_script_project生成 BP 脚本工程文件树(由你写入磁盘;可传 gameVersion

首次编写 / 项目初始化(必须遵守)

当用户要写 Script API、做脚本模组,或初始化项目,且工作区未见现成行为包脚本工程时:

  1. 先问语言:JavaScript 或 TypeScript;推荐 TypeScript
  2. 询问游戏版本(如 1.26.42),用 resolve_versions 确认包版本。
  3. 确认包名(可用 demo_pack)与模块(默认 server)。
  4. 调用 init_script_project(传入 gameVersion),把返回的 FILE: 区块写入工作区。
  5. 再用 get_symbol / search_by_tag / get_examples 写业务代码;长说明才用 get_page

init_script_project 不会直接写用户磁盘,必须由你落盘。

文档站:https://sapi.dogelake.cn/
完整 llms 索引:https://sapi.dogelake.cn/llms.txt
混合索引:https://sapi.dogelake.cn/mcp-data/api-index.json
版本映射数据:https://sapi.dogelake.cn/mcp-data/version-map.json
npm 包:sapi-docs-mcp

给用户的最短提示(可复制)

请帮我安装Minecraft Scripts API 中文文档 MCP:https://sapi.dogelake.cn/mcp-install.md