docs/sdk/tools.mdx
Tools are functions the model can call during execution. Tools consist of a name, description, and schema which the SDK sends to the model. Then the model can direct the SDK to execute tool functions and send results back into the conversation.
ClineCore can enable the built-in tool suite:
| Tool | Description |
|---|---|
read_files | Read one or more files |
search_codebase | Search the workspace |
run_commands | Execute shell commands |
fetch_web_content | Fetch web content |
apply_patch | Apply patch/diff edits |
editor | Edit files |
skills | Invoke configured skills |
ask_question | Ask the user for input |
submit_and_exit | Submit a final answer and stop |
One of the most powerful features of the SDK is the ability to create and register custom tools. This allows you to add and share capabilities that are context efficient and behave deterministically because they are implemented in code rather than prompts.
Use createTool with a zod schema for type-safe tools:
import { createTool } from "@cline/sdk"
import { z } from "zod"
const searchDatabase = createTool({
name: "search_database",
description: "Search the application database. Returns matching records as JSON.",
inputSchema: z.object({
query: z.string().describe("Search query"),
limit: z.number().optional().describe("Maximum results to return"),
}),
async execute(input) {
const results = await db.search(input.query, input.limit ?? 10)
return { results, count: results.length }
},
})
createTool also accepts raw JSON Schema if you prefer:
const searchDatabase = createTool({
name: "search_database",
description: "Search the application database.",
inputSchema: {
type: "object",
properties: {
query: { type: "string", description: "Search query" },
limit: { type: "number", description: "Maximum results to return" },
},
required: ["query"],
},
async execute(input) {
return await db.search(input.query, input.limit ?? 10)
},
})
For complete examples of tools in action, see the cli-agent (shell tool) and code-review-bot (multiple tools with completion lifecycle).
For a full tutorial, see Creating Custom Tools. For exact types, see Tools API.
With ClineCore, custom tools are passed as extraTools in session config:
await cline.start({
prompt: "Analyze customer records",
config: {
// ...
extraTools: [searchDatabase],
},
})
With Agent, you pass all tools into the constructor:
const agent = new Agent({
tools: [searchDatabase, myOtherTool],
// ...
})
Tools are more easily shared via plugins/extensions:
const plugin: AgentPlugin = {
name: "database-tools",
manifest: { capabilities: ["tools"] },
setup(api) {
api.registerTool(searchDatabase)
},
}
See Plugins for more info.
You can control how tools are used through Tool Policies. These control whether a tool is visible and whether it requires approval.
const agent = new Agent({
tools: [readTool, writeTool, deleteTool],
toolPolicies: {
read_data: { autoApprove: true },
write_data: { autoApprove: false },
delete_data: { enabled: false },
},
// ...
})
| Policy | Effect |
|---|---|
{ autoApprove: true } | Run without asking |
{ autoApprove: false } | Ask before running |
{ enabled: false } | Hide/disable the tool |
Tool names not listed in toolPolicies default to enabled and auto-approved.
Tools work along side MCP. ClineCore can load MCP settings through its runtime/config extension path. MCP tools are registered alongside built-in and custom tools when MCP support is enabled for the session.