RankHub

API 目前处于 Early Preview 阶段, 可能存在诸多不完善与错误之处,欢迎加群交流反馈:加入官方交流群(1073434398)

AI 与 LLM 集成

把 RankHub 文档喂给 ChatGPT / Claude / Cursor:llms.txt、llms-full.txt、逐页 Markdown 与页面上的「复制 Markdown / 在 AI 中打开」。

本页面向用 AI 辅助接 API 的开发者。文档站本身已经是 AI 友好的:既有给模型看的纯文本索引, 也有逐页 Markdown。不需要爬 HTML。

三个入口

入口内容适合
/llms.txt全部页面的标题 + 链接(精简索引)先让模型知道「有哪些页」
/llms-full.txt全部页面正文拼成的单个 Markdown 文件一次性喂给长上下文模型 / 建知识库
/llms.mdx/docs/<路径>/content.md单页的 Markdown(与页面正文一致)只把相关页发给模型,省 token
# 索引
curl -sS https://www.rankhub.cc/llms.txt

# 全量正文(较长,建议保存后作为附件)
curl -sS https://www.rankhub.cc/llms-full.txt -o rankhub-docs.md

# 单页:与页面 URL 一一对应
curl -sS https://www.rankhub.cc/llms.mdx/docs/developers/handbook/games/maimai/content.md

路径规则:/docs/<...slug> ⇄ /llms.mdx/docs/<...slug>/content.md。 例如本页是 /llms.mdx/docs/developers/handbook/ai/content.md。

页面上的两个按钮

每篇文档标题下方有两个操作:

  • 复制 Markdown:把当前页正文复制到剪贴板,直接粘进对话;
  • Open:用当前页 URL 在 ChatGPT / Claude / Cursor 中打开提问(由浏览器/客户端处理)。

给模型的最小提示词

你是 RankHub Open API 的接入助手。请只依据我提供的文档回答,不要猜测字段。
文档:<粘贴 /llms.mdx/.../content.md 的内容,或上传 llms-full.txt>
问题:我要给 maimai 推成绩,最少要传哪些字段?评分值谁算?

要点:

  1. 先给形状:player / scores[] / native 三个词在文档里含义固定,模型容易混淆,提示词里点明;
  2. 限定游戏:rating 谁算、difficulty 取值都随游戏变,让模型先说「哪个游戏」;
  3. 让它引用:要求模型回答时带页面路径(例如 games/maimai#评分语义与量纲),方便你回查;
  4. 别让它编 native 键:native 字段以各游戏页 / GET /v1/games/{game}/format 为准。

MCP 服务器

文档站同时是一个 MCP 服务器:AI 客户端可以直接检索和读取文档, 不必先下载 llms-full.txt。

  • 端点:https://www.rankhub.cc/api/mcp(Streamable HTTP);
  • 工具(来自 fumadocs-core/mcp):
工具输入输出
list_pages无全部页面索引(标题 + URL)
get_pageurl(如 /docs/developers/handbook/games/maimai)该页 Markdown
searchquery、可选 locale搜索命中(页面 + 片段)

在支持 MCP 的客户端里加一条配置即可(Claude Desktop / Cursor / Cline 等同理):

{
  "mcpServers": {
    "rankhub-docs": {
      "url": "https://www.rankhub.cc/api/mcp"
    }
  }
}

工具是只读的:只能列页、读页、搜索,不接受写入或执行。端点不需要鉴权, 与公开文档可见范围一致;若你希望离线使用,仍然用上面的 llms-full.txt。

边界

  • llms*.txt 只包含公开文档,不含任何用户数据、凭据或内部实现;
  • 文档会随版本更新,缓存过久时请重新拉取 llms-full.txt;
  • AI 生成的代码仍需按错误与排障自行校验,尤其是 428 / 403 分支。

本页内容

官方交流群二维码官方交流群问题反馈 · 版本资讯 · 成绩交流群号 1073434398