> ## Documentation Index
> Fetch the complete documentation index at: https://docs.siflow.cn/llms.txt
> Use this file to discover all available pages before exploring further.

# 使用 AI 查阅算秩文档

> 了解如何通过 MCP、llms.txt、skill.md 和 Markdown 页面，让 AI 工具查询算秩各产品线文档。

您可以将算秩文档接入 Claude Code、Codex、Cursor 等 AI 工具，让 AI 基于文档回答模型推理服务、人工智能平台和 GPU 云服务相关问题，例如如何选择模型、调用 API、准备资源、提交训练任务、使用 Python SDK、管理实例和集群，或配置存储与监控告警。

## 选择方式

建议优先使用 MCP。MCP 适合在 IDE、编程智能体或桌面 AI 客户端中长期查询算秩文档，AI 工具可以按需检索文档内容，不需要每次手动复制页面链接或文档正文。

如果您的 AI 工具暂不支持 MCP，可以根据使用场景选择其他读取方式。

| 使用场景 | 推荐方式 |
| - | - |
| AI 工具支持 MCP，希望长期查询文档 | 使用 MCP |
| AI Agent 支持技能或能力描述 | 使用 `skill.md` |
| 想让 AI 了解文档站有哪些页面 | 使用 `llms.txt` |
| 想让 AI 一次性读取完整文档内容 | 使用 `llms-full.txt` |
| 只需要 AI 阅读某一篇文档 | 使用单页 Markdown |

## MCP 接入

如果您的 AI 工具支持 Model Context Protocol（MCP），可以通过 MCP 连接算秩文档。连接后，AI 工具可以围绕具体问题检索相关文档，并基于文档内容回答问题。

### 接入地址

在 AI 工具中添加 MCP 服务时，请将以下地址作为算秩文档 MCP 服务入口。

```text theme={null}
https://docs.siflow.cn/mcp
```

### 工具能力

接入后，AI 工具可以使用以下文档能力：

| 工具 | 作用 |
| - | - |
| `search` | 搜索算秩文档，查找与问题相关的页面、指南和接口说明。 |
| `query_docs_filesystem` | 读取文档虚拟文件系统中的页面内容，适合查看完整文档、目录结构或精确匹配关键词。 |
| `submit_feedback` | 向文档团队提交反馈，用于报告文档错误、过期信息、表述不清或示例问题。 |

### 典型问题示例

您可以围绕当前产品和任务提问，例如：

| 产品线 | 问题示例 |
| - | - |
| 模型推理服务 | <ul><li>我应该选哪个模型？</li><li>怎么创建 API Key 并调用模型？</li><li>API 请求报错了怎么排查？</li><li>怎么查看 token 用量和费用？</li></ul> |
| 人工智能平台 | <ul><li>第一次使用前要准备哪些资源？</li><li>我应该用开发环境、训练任务，还是推理服务？</li><li>训练任务排队或失败了怎么排查？</li></ul> |
| GPU 云服务 | <ul><li>应该选 CES 实例还是 Kubernetes 集群？</li><li>共享数据应该用 GPFS 还是 OSS？</li><li>如何查看监控数据？</li><li>怎么订阅告警？</li></ul> |

### 在 Claude Code 中配置

Claude Code 以命令行工作流为主。建议在需要使用算秩文档的项目目录中，执行以下命令添加 MCP 服务：

```bash theme={null}
claude mcp add --transport http siflow-docs https://docs.siflow.cn/mcp
```

配置完成后，可以执行以下命令检查连接状态：

```bash theme={null}
claude mcp list
```

### 在 Codex 中配置

如果您使用的是支持图形化 MCP 配置的 Codex 客户端，可以在应用内添加 MCP 服务，并将服务地址设置为 `https://docs.siflow.cn/mcp`。

如果需要在多个项目或 IDE 中复用配置，也可以使用 CLI 或配置文件方式。

```bash theme={null}
codex mcp add siflowDocs --url https://docs.siflow.cn/mcp
```

配置完成后，可以执行以下命令检查连接状态：

```bash theme={null}
codex mcp list
```

您也可以直接编辑 Codex 配置文件，例如 `~/.codex/config.toml`，添加以下配置：

```toml theme={null}
[mcp_servers.siflowDocs]
url = "https://docs.siflow.cn/mcp"
```

## 其他读取方式

### 使用 skill.md

`skill.md` 用于向 AI Agent 描述文档站和产品能力，适合支持技能或 Agent 上下文的工具读取。

```text theme={null}
https://docs.siflow.cn/skill.md
```

### 使用 llms.txt

`llms.txt` 提供文档站的页面索引，适合让 AI 先了解站点中有哪些文档。

```text theme={null}
https://docs.siflow.cn/llms.txt
```

### 使用 llms-full.txt

`llms-full.txt` 提供更完整的文档内容，适合需要让 AI 一次性读取较多文档上下文的场景。

```text theme={null}
https://docs.siflow.cn/llms-full.txt
```

> [!WARNING]
>
> `llms-full.txt` 可能包含较多内容。部分 AI 工具存在上下文长度限制，如遇到内容过长，可改用 MCP、`llms.txt` 或单页 Markdown。

### 使用单页 Markdown

每篇文档都可以通过 Markdown 格式读取。将页面 URL 后缀改为 `.md`，即可获得更适合 AI 读取的纯文本内容。

示例如下：

```text theme={null}
https://docs.siflow.cn/model-inference/get-started/first-api-call.md
https://docs.siflow.cn/ai-platform/training/create-training-tasks.md
https://docs.siflow.cn/gpu-cloud/get-started/quickstart-instance.md
```

## 使用建议

* 查询产品概念、操作步骤和配置说明时，优先让 AI 基于 MCP 或具体页面 Markdown 回答。
* 涉及模型列表、价格、配额、资源余量或库存、任务和服务状态、实例和集群状态、订单及控制台配置等实时信息时，请同时以控制台页面展示为准。
* 如果 AI 回答与文档内容不一致，请以文档站页面展示的内容为准。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.