mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
locadex-agent[bot]
8560a15677
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
91 lines
4.5 KiB
Plaintext
91 lines
4.5 KiB
Plaintext
---
|
||
title: "skill.md"
|
||
description: "通过结构化的能力文件，让你的文档随时可供智能体使用。"
|
||
keywords: ["AI 智能体", "技能", "智能体技能", "智能体"]
|
||
---
|
||
|
||
Mintlify 会在你项目的根目录托管一个 `skill.md` 文件，用于描述 AI agent 在你的产品中可以执行哪些操作。
|
||
|
||
[skill.md 规范](https://agentskills.io/specification) 是一种结构化、机器可读的格式，它将产品的能力、必填输入以及约束条件显式列出，从而让 agent 能更可靠地使用这些能力。
|
||
|
||
Mintlify 会通过一个 agentic loop 分析你的文档，自动为你的项目生成一个 `skill.md` 文件。随着你更新文档，这个文件会自动保持最新且无需维护。你也可以选择在项目根目录添加一个自定义的 `skill.md` 文件，以覆盖自动生成的版本。
|
||
|
||
在你的文档站点 URL 末尾追加 `/skill.md`，即可查看你的 `skill.md`。Mintlify 只会为公开的文档站点生成 `skill.md` 文件。
|
||
|
||
<PreviewButton href="https://mintlify.com/docs/skill.md">打开本站点的 skill.md。</PreviewButton>
|
||
|
||
<Tip>
|
||
`llms.txt` 和 `skill.md` 都帮助 agent 使用你的文档，但它们的作用不同。
|
||
|
||
* `llms.txt` 是一个目录。它列出你所有的文档页面及其说明，让 agent 知道去哪里查找信息。
|
||
* `skill.md` 是一个能力概览。它告诉 agent 使用你的产品可以完成什么、需要哪些输入，以及有哪些约束条件。
|
||
</Tip>
|
||
|
||
<div id="use-skillmd-files-with-agents">
|
||
## 将 `skill.md` 文件与代理一起使用
|
||
</div>
|
||
|
||
<Note>
|
||
如果你使用 [反向代理](/zh/deploy/reverse-proxy)，请将其配置为将对 `/skill.md` 和 `/.well-known/skills/*` 路径的请求（禁用缓存）转发到你的 Mintlify 子域。
|
||
</Note>
|
||
|
||
代理可以使用 [skills 命令行界面（CLI）](https://www.npmjs.com/package/skills) 来处理你的 `skill.md`。
|
||
|
||
```bash
|
||
npx skills add https://your-docs-domain.com
|
||
```
|
||
|
||
这会将你的产品功能添加到代理的 context 中，使其能够代表用户执行操作。
|
||
|
||
<Tip>
|
||
向你的用户讲解如何将 `skill.md` 文件与代理配合使用，以便他们在结合你的产品使用 AI 工具时获得更好的效果。
|
||
</Tip>
|
||
|
||
<div id="skillmd-structure">
|
||
## `skill.md` 结构
|
||
</div>
|
||
|
||
Mintlify 会根据 [agentskills.io 规范](https://agentskills.io/specification) 生成一个 `skill.md` 文件。生成的文件包括：
|
||
|
||
* **Metadata**：项目名称、说明和版本。
|
||
* **Capabilities**：智能体可以通过你的产品完成的能力范围。
|
||
* **Skills**：按类别组织的具体操作。
|
||
* **Workflows**：常见任务的分步流程。
|
||
* **Integration**：支持的工具和服务。
|
||
* **Context**：与你产品架构相关的背景信息。
|
||
|
||
<div id="custom-skillmd-files">
|
||
## 自定义 `skill.md` 文件
|
||
</div>
|
||
|
||
在项目根目录添加一个 `skill.md` 文件，以覆盖自动生成的文件。若删除自定义文件，Mintlify 会重新生成一个 `skill.md` 文件。
|
||
|
||
当你希望对智能体如何与产品交互进行精细控制时，可以编写自定义文件。请遵循 [agentskills.io 规范](https://agentskills.io/specification) 以确保与智能体工具的兼容性。
|
||
|
||
<div id="frontmatter-fields">
|
||
### Frontmatter 字段
|
||
</div>
|
||
|
||
自定义 `skill.md` 文件必须以 YAML frontmatter 开头。
|
||
|
||
| Field | Type | Description |
|
||
| --------------- | ------ | --------------------------------------------------------- |
|
||
| `name` | string | 该技能的名称。 |
|
||
| `description` | string | 该技能功能的简要说明。 |
|
||
| `license` | string | 该技能的许可证（例如，`MIT`、`Apache-2.0`）。 |
|
||
| `compatibility` | string | 运行要求或兼容性说明（例如，运行时依赖）。 |
|
||
| `metadata` | object | 以字符串形式的 key-value 对提供的附加 metadata（例如，`author`、`version`）。 |
|
||
| `allowed-tools` | string | 以空格分隔的、预先批准可供该技能使用的工具列表（实验性）。 |
|
||
|
||
```md Example frontmatter
|
||
---
|
||
name: mintlify
|
||
description: 使用 Mintlify 构建和维护文档站点。用于创建文档页面、配置导航、添加组件或设置 API 参考。
|
||
license: MIT
|
||
compatibility: Requires Node.js for CLI. Works with any Git-based workflow.
|
||
metadata:
|
||
author: mintlify
|
||
version: "1.0"
|
||
---
|
||
```
|