Turtle
07d24b005f
Update every doc referencing base.cordis.yml/web.cordis.yml, --config, -p, or $DSH_HOME/config.yaml to the profile vocabulary with bilingual counterparts re-recorded; regenerate the catalogs and graphs; add the profile-plugin-bundles Agent Note recording the design and its rejected alternatives.
53 lines
1.7 KiB
Markdown
53 lines
1.7 KiB
Markdown
# Build a tool
|
|
|
|
English | [中文](tool.zh.md)
|
|
|
|
This tutorial adds a `greet` tool to the Web UI. Complete [Your first plugin](./) first and keep its `scratch-plugin` directory.
|
|
|
|
## Create the tool plugin
|
|
|
|
Replace `scratch-plugin/src/my-plugin.ts` with:
|
|
|
|
```ts
|
|
import type { Context } from 'cordis'
|
|
import { defineTool } from '@deepseek-ai/dsh-tools'
|
|
|
|
export const name = 'greet-tool'
|
|
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' },
|
|
},
|
|
output: {
|
|
schema: { type: 'string' },
|
|
render: (_args, value) => [{ type: 'text', text: value }],
|
|
},
|
|
async execute(args) {
|
|
return `Hello, ${args.name}!`
|
|
},
|
|
}))
|
|
}
|
|
```
|
|
|
|
`inject` makes Cordis wait for the tool registry. `defineTool` infers and validates `args` from `parameters`; `execute` returns the canonical value declared by `output.schema`, and `output.render` converts that value to model-facing content.
|
|
|
|
## Run and call the tool
|
|
|
|
Restart the development command if it is not running:
|
|
|
|
```sh
|
|
pnpm run dsh web --patch ./scratch-plugin/cordis.yml
|
|
```
|
|
|
|
Open `http://127.0.0.1:3080` and ask: `Use the greet tool to greet Ada.` The model can call `greet` and receives `Hello, Ada!` as the tool result.
|
|
|
|
## Next steps
|
|
|
|
- [Plugin configuration](./config.md) — make the greeting configurable.
|
|
- [Tool authoring reference](../../../cookbook/adding-a-tool.md) — look up nested schemas, canonical values, background work, policy hooks, Code Mode, and UI cards.
|
|
- [Capability layering](../practice/) — split a replaceable capability into interface, implementation, and consumer packages.
|