技能

技能是智能体可以调用的能力。本指南介绍如何添加和管理技能。

API 参考

add_skill()

向知识库添加技能。

参数

参数	类型	必填	默认值	说明
data	Any	是	-	技能数据。裸 HTTP 支持结构化数据或原始 `SKILL.md` 内容，不支持直接传宿主机路径
temp_file_id	str	否	None	`POST /api/v1/resources/temp_upload` 返回的上传 ID，用于裸 HTTP 导入本地文件
wait	bool	否	False	等待向量化完成
timeout	float	否	None	超时时间（秒）

本地技能文件如何处理

Python SDK 和 CLI 可以直接接收本地 SKILL.md 文件或目录。处于 HTTP 模式时，它们会先自动上传，再调用服务端 API。
裸 HTTP 调用有三种推荐方式：
- 在 data 中直接传结构化 skill 数据
- 在 data 中直接传原始 SKILL.md 内容
- 先调用 POST /api/v1/resources/temp_upload 上传本地 SKILL.md 文件，再调用 POST /api/v1/skills 并传入 temp_file_id
- 先把本地 skill 目录打成 .zip，上传该压缩包，再调用 POST /api/v1/skills 并传入 temp_file_id
POST /api/v1/skills 不接受在 data 中直接传宿主机本地路径。

支持的数据格式

字典（技能格式）：

python

{
    "name": "skill-name",
    "description": "Skill description",
    "content": "Full markdown content",
    "allowed_tools": ["Tool1", "Tool2"],  # 可选
    "tags": ["tag1", "tag2"]  # 可选
}

字典（MCP Tool 格式） - 自动检测并转换：

python

{
    "name": "tool_name",
    "description": "Tool description",
    "inputSchema": {
        "type": "object",
        "properties": {...},
        "required": [...]
    }
}

字符串（SKILL.md 内容）：

python

"""---
name: skill-name
description: Skill description
---

# Skill Content
"""

路径（文件或目录）：
- 单个文件：指向 SKILL.md 文件的路径
- 目录：指向包含 SKILL.md 的目录路径（辅助文件会一并包含）

Python SDK (Embedded / HTTP)

python

skill = {
    "name": "search-web",
    "description": "Search the web for current information",
    "content": """
# search-web

Search the web for current information.

## Parameters
- **query** (string, required): Search query
- **limit** (integer, optional): Max results, default 10
"""
}

result = client.add_skill(skill)
print(f"Added: {result['root_uri']}")

HTTP API

POST /api/v1/skills

bash

curl -X POST http://localhost:1933/api/v1/skills \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-key" \
  -d '{
    "data": {
      "name": "search-web",
      "description": "Search the web for current information",
      "content": "# search-web\n\nSearch the web for current information.\n\n## Parameters\n- **query** (string, required): Search query\n- **limit** (integer, optional): Max results, default 10"
    }
  }'

CLI

bash

openviking add-skill ./my-skill/ [--wait]

响应

json

{
  "status": "ok",
  "result": {
    "status": "success",
    "root_uri": "viking://agent/skills/search-web/",
    "uri": "viking://agent/skills/search-web/",
    "name": "search-web",
    "auxiliary_files": 0
  },
  "time": 0.1
}

同步处理错误

如果 skill 解析或处理同步失败，裸 HTTP 会返回标准错误 envelope，并使用非 2xx HTTP 状态码：

json

{
  "status": "error",
  "error": {
    "code": "PROCESSING_ERROR",
    "message": "Skill parse error: invalid skill metadata"
  }
}

Python HTTP SDK 会把该响应映射为对应异常。

示例：从 MCP Tool 添加

Python SDK (Embedded / HTTP)

python

# MCP tool 格式会被自动检测并转换
mcp_tool = {
    "name": "calculator",
    "description": "Perform mathematical calculations",
    "inputSchema": {
        "type": "object",
        "properties": {
            "expression": {
                "type": "string",
                "description": "Mathematical expression to evaluate"
            }
        },
        "required": ["expression"]
    }
}

result = client.add_skill(mcp_tool)
print(f"Added: {result['uri']}")

HTTP API

bash

curl -X POST http://localhost:1933/api/v1/skills \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-key" \
  -d '{
    "data": {
      "name": "calculator",
      "description": "Perform mathematical calculations",
      "inputSchema": {
        "type": "object",
        "properties": {
          "expression": {
            "type": "string",
            "description": "Mathematical expression to evaluate"
          }
        },
        "required": ["expression"]
      }
    }
  }'

示例：从 SKILL.md 文件添加

Python SDK (Embedded / HTTP)

python

# 从文件路径添加
result = client.add_skill("./skills/search-web/SKILL.md")
print(f"Added: {result['uri']}")

# 从目录添加（包含辅助文件）
result = client.add_skill("./skills/code-runner/")
print(f"Added: {result['uri']}")
print(f"Auxiliary files: {result['auxiliary_files']}")

HTTP API

bash

# 第一步：上传本地 SKILL.md 文件
TEMP_FILE_ID=$(
  curl -sS -X POST http://localhost:1933/api/v1/resources/temp_upload \
    -H "X-API-Key: your-key" \
    -F 'file=@./skills/search-web/SKILL.md' \
  | jq -r '.result.temp_file_id'
)

# 第二步：添加上传后的技能文件
curl -X POST http://localhost:1933/api/v1/skills \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-key" \
  -d "{
    \"temp_file_id\": \"$TEMP_FILE_ID\"
  }"

如果是本地 skill 目录，先把目录打成 .zip，上传该压缩包，再用返回的 temp_file_id 调用同一个 POST /api/v1/skills 请求即可。

SKILL.md 格式

技能可以使用带有 YAML frontmatter 的 SKILL.md 文件来定义。

结构

markdown

---
name: skill-name
description: Brief description of the skill
allowed-tools:
  - Tool1
  - Tool2
tags:
  - tag1
  - tag2
---

# Skill Name

Full skill documentation in Markdown format.

## Parameters
- **param1** (type, required): Description
- **param2** (type, optional): Description

## Usage
When and how to use this skill.

## Examples
Concrete examples of skill invocation.

必填字段

字段	类型	说明
name	str	技能名称（建议使用 kebab-case）
description	str	简要描述

可选字段

字段	类型	说明
allowed-tools	List[str]	该技能可使用的工具
tags	List[str]	用于分类的标签

管理技能

列出技能

Python SDK (Embedded / HTTP)

python

# 列出所有技能
skills = client.ls("viking://agent/skills/")
for skill in skills:
    print(f"{skill['name']}")

# 简单列表（仅名称）
names = client.ls("viking://agent/skills/", simple=True)
print(names)

HTTP API

bash

curl -X GET "http://localhost:1933/api/v1/fs/ls?uri=viking://agent/skills/" \
  -H "X-API-Key: your-key"

读取技能内容

Python SDK (Embedded / HTTP)

python

uri = "viking://agent/skills/search-web/"

# L0：简要描述
abstract = client.abstract(uri)
print(f"Abstract: {abstract}")

# L1：参数和使用概览
overview = client.overview(uri)
print(f"Overview: {overview}")

# L2：完整技能文档
content = client.read(uri)
print(f"Content: {content}")

HTTP API

bash

# L0：简要描述
curl -X GET "http://localhost:1933/api/v1/content/abstract?uri=viking://agent/skills/search-web/" \
  -H "X-API-Key: your-key"

# L1：参数和使用概览
curl -X GET "http://localhost:1933/api/v1/content/overview?uri=viking://agent/skills/search-web/" \
  -H "X-API-Key: your-key"

# L2：完整技能文档
curl -X GET "http://localhost:1933/api/v1/content/read?uri=viking://agent/skills/search-web/" \
  -H "X-API-Key: your-key"

搜索技能

Python SDK (Embedded / HTTP)

python

# 语义搜索技能
results = client.find(
    "search the internet",
    target_uri="viking://agent/skills/",
    limit=5
)

for ctx in results.skills:
    print(f"Skill: {ctx.uri}")
    print(f"Score: {ctx.score:.3f}")
    print(f"Description: {ctx.abstract}")

HTTP API

bash

curl -X POST http://localhost:1933/api/v1/search/find \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-key" \
  -d '{
    "query": "search the internet",
    "target_uri": "viking://agent/skills/",
    "limit": 5
  }'

删除技能

Python SDK (Embedded / HTTP)

python

client.rm("viking://agent/skills/old-skill/", recursive=True)

HTTP API

bash

curl -X DELETE "http://localhost:1933/api/v1/fs?uri=viking://agent/skills/old-skill/&recursive=true" \
  -H "X-API-Key: your-key"

MCP 转换

OpenViking 会自动检测并将 MCP tool 定义转换为技能格式。

检测

如果字典包含 inputSchema 字段，则被视为 MCP 格式：

python

if "inputSchema" in data:
    # 转换为技能格式
    skill = mcp_to_skill(data)

转换过程

名称转换为 kebab-case
描述保持不变
从 inputSchema.properties 中提取参数
从 inputSchema.required 中标记必填字段
生成 Markdown 内容

转换示例

输入（MCP 格式）：

python

{
    "name": "search_web",
    "description": "Search the web",
    "inputSchema": {
        "type": "object",
        "properties": {
            "query": {
                "type": "string",
                "description": "Search query"
            },
            "limit": {
                "type": "integer",
                "description": "Max results"
            }
        },
        "required": ["query"]
    }
}

输出（技能格式）：

python

{
    "name": "search-web",
    "description": "Search the web",
    "content": """---
name: search-web
description: Search the web
---

# search-web

Search the web

## Parameters

- **query** (string) (required): Search query
- **limit** (integer) (optional): Max results

## Usage

This tool wraps the MCP tool `search-web`. Call this when the user needs functionality matching the description above.
"""
}

技能存储结构

技能存储在 viking://agent/skills/ 路径下：

viking://agent/skills/
+-- search-web/
|   +-- .abstract.md      # L0：简要描述
|   +-- .overview.md      # L1：参数和使用概览
|   +-- SKILL.md          # L2：完整文档
|   +-- [auxiliary files]  # 其他辅助文件
+-- calculator/
|   +-- .abstract.md
|   +-- .overview.md
|   +-- SKILL.md
+-- ...

最佳实践

清晰的描述

python

# 好 - 具体且可操作
skill = {
    "name": "search-web",
    "description": "Search the web for current information using Google",
    ...
}

# 不够好 - 过于模糊
skill = {
    "name": "search",
    "description": "Search",
    ...
}

全面的内容

技能内容应包含：

清晰的参数描述及类型
何时使用该技能
具体示例
边界情况和限制

一致的命名

技能名称使用 kebab-case：

search-web（推荐）
searchWeb（避免）
search_web（避免）

技能 ​

API 参考 ​

add_skill() ​

SKILL.md 格式 ​

管理技能 ​

列出技能 ​

读取技能内容 ​

搜索技能 ​

删除技能 ​

MCP 转换 ​

技能存储结构 ​

最佳实践 ​

清晰的描述 ​

全面的内容 ​

一致的命名 ​

相关文档 ​

技能

API 参考

add_skill()

SKILL.md 格式

管理技能

列出技能

读取技能内容

搜索技能

删除技能

MCP 转换

技能存储结构

最佳实践

清晰的描述

全面的内容

一致的命名

相关文档