2026-08-09 03:20:17 +08:00
|
|
|
|
# 开发一个工具
|
2026-07-09 16:07:58 +08:00
|
|
|
|
|
2026-07-15 18:08:28 +08:00
|
|
|
|
[English](tool.md) | 中文
|
|
|
|
|
|
|
2026-08-18 19:00:37 +08:00
|
|
|
|
本教程会在 Web UI 中添加一个 `greet` 工具。请先完成[第一个插件](./index.zh.md),并保留其中的 `scratch-plugin` 目录。
|
2026-07-09 16:07:58 +08:00
|
|
|
|
|
2026-08-05 12:46:38 +08:00
|
|
|
|
## 创建工具插件
|
|
|
|
|
|
|
|
|
|
|
|
将 `scratch-plugin/src/my-plugin.ts` 替换为:
|
2026-07-09 16:07:58 +08:00
|
|
|
|
|
2026-07-15 18:08:28 +08:00
|
|
|
|
```ts
|
build(vendor): rescope the vendored Cordis packages into @deepseek-ai
Machine-produced by `pnpm run rescope-vendor --apply` plus the regeneration it
prints: `pnpm install` for the lockfile, `pnpm run gen-third-party-notices`,
`verify-translation-pairing --write` for the touched bilingual pairs,
`gen-doc-graphs`, and one typert snapshot whose ids embed character offsets.
`pnpm run rescope-vendor --check` verifies the result.
Renames nine vendored packages (cordis, cosmokit, schemastery and the six
@cordisjs plugins) and every reference that resolves them: manifest names and
dependency keys, module specifiers including declare-module merges, cordis.yml
plugin names, tsconfig paths, every Markdown fence, and `docs/` prose.
Directory names, upstream versions, and dependency ranges are unchanged, so
vendor/README.md still reads as an upstream snapshot; its manifest table gains
an upstream-name column so THIRD_PARTY_NOTICES keeps MIT attribution pointed
at each fork's origin.
The tutorial tier follows the rename end to end: its yaml fences named plugins
the Loader can no longer resolve, its `ts ignore-check` fences disagreed with
the compiled fences beside them, and its prose quoted both. The contracts that
told readers to keep upstream names — the root convention and the vendoring
cookbook's tree comment and manifest invariant — now say to rescope instead.
Two rules read `@deepseek-ai/` as "another workspace plugin": the client bundle
purity gate now names the vendored libraries a browser bundle inlines, and the
files where a bare `cordis` is an agent-preset id keep that product data.
2026-08-10 22:04:06 +08:00
|
|
|
|
import type { Context } from '@deepseek-ai/cordis'
|
2026-07-09 16:07:58 +08:00
|
|
|
|
import { defineTool } from '@deepseek-ai/dsh-tools'
|
|
|
|
|
|
|
2026-08-05 12:46:38 +08:00
|
|
|
|
export const name = 'greet-tool'
|
2026-07-09 16:07:58 +08:00
|
|
|
|
export const inject = ['tools']
|
|
|
|
|
|
|
|
|
|
|
|
export function apply(ctx: Context) {
|
|
|
|
|
|
ctx.tools.register(defineTool({
|
|
|
|
|
|
name: 'greet',
|
|
|
|
|
|
description: 'Greet someone by name.',
|
|
|
|
|
|
parameters: {
|
|
|
|
|
|
name: { type: 'string', required: true, description: 'The name to greet' },
|
|
|
|
|
|
},
|
2026-07-21 03:08:35 +08:00
|
|
|
|
output: {
|
|
|
|
|
|
schema: { type: 'string' },
|
|
|
|
|
|
render: (_args, value) => [{ type: 'text', text: value }],
|
|
|
|
|
|
},
|
2026-07-09 16:07:58 +08:00
|
|
|
|
async execute(args) {
|
2026-07-21 03:08:35 +08:00
|
|
|
|
return `Hello, ${args.name}!`
|
2026-07-09 16:07:58 +08:00
|
|
|
|
},
|
|
|
|
|
|
}))
|
|
|
|
|
|
}
|
|
|
|
|
|
```
|
|
|
|
|
|
|
2026-08-05 12:46:38 +08:00
|
|
|
|
`inject` 让 Cordis 等待工具注册表就绪。`defineTool` 根据 `parameters` 推导并校验 `args`;`execute` 返回 `output.schema` 声明的规范值,`output.render` 再将该值转换为面向模型的内容。
|
2026-07-09 16:07:58 +08:00
|
|
|
|
|
2026-08-05 12:46:38 +08:00
|
|
|
|
## 运行并调用工具
|
2026-07-09 16:07:58 +08:00
|
|
|
|
|
2026-08-05 12:46:38 +08:00
|
|
|
|
如果开发命令未在运行,请重新启动:
|
2026-07-09 16:07:58 +08:00
|
|
|
|
|
2026-08-05 12:46:38 +08:00
|
|
|
|
```sh
|
2026-08-10 16:01:12 +08:00
|
|
|
|
pnpm dsh web --patch ./scratch-plugin/cordis.yml
|
2026-07-09 16:07:58 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
2026-08-05 12:46:38 +08:00
|
|
|
|
打开 `http://127.0.0.1:3080`,然后输入:`Use the greet tool to greet Ada.` 模型可以调用 `greet`,并收到 `Hello, Ada!` 这一工具结果。
|
2026-07-09 16:07:58 +08:00
|
|
|
|
|
|
|
|
|
|
## 下一步
|
|
|
|
|
|
|
2026-08-18 19:00:37 +08:00
|
|
|
|
- [插件配置](./config.zh.md) — 让问候语可配置。
|
|
|
|
|
|
- [工具编写参考](../../../cookbook/adding-a-tool.zh.md) — 查阅嵌套 schema、规范值、后台工作、策略钩子、Code Mode 和 UI 卡片。
|
|
|
|
|
|
- [能力分层](../practice/index.zh.md) — 将可替换能力拆分为 Service Definition、Service Provider 和 Consumer 三类包。
|