自定义工具
自定义工具是你创建的函数，LLM 可以在对话过程中调用它们。它们与 mimocode 的内置工具（如 read、write 和 bash）协同工作。
创建工具
工具以 TypeScript 或 JavaScript 文件的形式定义。不过，工具定义可以调用任何语言编写的脚本——TypeScript 或 JavaScript 仅用于工具定义本身。
位置
工具可以在以下位置定义：
- 本地定义：将工具文件放在项目的
.mimocode/tools/ 目录中。
- 全局定义：将工具文件放在
~/.config/mimocode/tools/ 中。
结构
创建工具最简单的方式是使用 tool() 辅助函数，它提供类型安全和参数校验。
1import { tool } from "@@mimocode/cli/plugin"
2
3export default tool({
4 description: "Query the project database",
5 args: {
6 query: tool.schema.string().describe("SQL query to execute"),
7 },
8 async execute(args) {
9 // Your database logic here
10 return `Executed query: ${args.query}`
11 },
12})
文件名即为工具名称。上面的示例创建了一个名为 database 的工具。
单文件多工具
你也可以从单个文件中导出多个工具。每个导出都会成为一个独立的工具，命名格式为 <filename>_<exportname>：
1import { tool } from "@@mimocode/cli/plugin"
2
3export const add = tool({
4 description: "Add two numbers",
5 args: {
6 a: tool.schema.number().describe("First number"),
7 b: tool.schema.number().describe("Second number"),
8 },
9 async execute(args) {
10 return args.a + args.b
11 },
12})
13
14export const multiply = tool({
15 description: "Multiply two numbers",
16 args: {
17 a: tool.schema.number().describe("First number"),
18 b: tool.schema.number().describe("Second number"),
19 },
20 async execute(args) {
21 return args.a * args.b
22 },
23})
这会创建两个工具：math_add 和 math_multiply。
与内置工具的名称冲突
自定义工具通过工具名称进行索引。如果自定义工具使用了与内置工具相同的名称，则优先使用自定义工具。
例如，这个文件取代了内置的bash工具：
1import { tool } from "@@mimocode/cli/plugin"
2
3export default tool({
4 description: "Restricted bash wrapper",
5 args: {
6 command: tool.schema.string(),
7 },
8 async execute(args) {
9 return `blocked: ${args.command}`
10 },
11})
NOTE: 除非你有意替换内置工具，否则最好用独特的名字。如果你想禁用内置工具但不想覆盖它，使用 权限。
参数
你可以使用 tool.schema（即 Zod）来定义参数类型。
1args: {
2 query: tool.schema.string().describe("SQL query to execute")
3}
你也可以直接导入 Zod 并返回一个普通对象：
1import { z } from "zod"
2
3export default {
4 description: "Tool description",
5 args: {
6 param: z.string().describe("Parameter description"),
7 },
8 async execute(args, context) {
9 // Tool implementation
10 return "result"
11 },
12}
上下文
工具会接收当前会话的上下文信息：
1import { tool } from "@@mimocode/cli/plugin"
2
3export default tool({
4 description: "Get project information",
5 args: {},
6 async execute(args, context) {
7 // Access context information
8 const { agent, sessionID, messageID, directory, worktree } = context
9 return `Agent: ${agent}, Session: ${sessionID}, Message: ${messageID}, Directory: ${directory}, Worktree: ${worktree}`
10 },
11})
使用 context.directory 获取会话的工作目录。 使用 context.worktree 获取 git worktree 根目录。
示例
用 Python 编写工具
你可以使用任何语言编写工具。以下示例展示了如何用 Python 实现两数相加。
首先，创建一个 Python 脚本作为工具：
1import sys
2
3a = int(sys.argv[1])
4b = int(sys.argv[2])
5print(a + b)
然后创建调用该脚本的工具定义：
1import { tool } from "@@mimocode/cli/plugin"
2import path from "path"
3
4export default tool({
5 description: "Add two numbers using Python",
6 args: {
7 a: tool.schema.number().describe("First number"),
8 b: tool.schema.number().describe("Second number"),
9 },
10 async execute(args, context) {
11 const script = path.join(context.worktree, ".mimocode/tools/add.py")
12 const result = await Bun.$`python3 ${script} ${args.a} ${args.b}`.text()
13 return result.trim()
14 },
15})
这里我们使用 Bun.$ 工具函数来运行 Python 脚本。
