MCPcopy
hub / github.com/CopilotKit/CopilotKit / defineTool

Function defineTool

packages/runtime/src/agent/index.ts:292–310  ·  view source on GitHub ↗
(config: {
  name: string;
  description: string;
  parameters: TParameters;
  execute?: (args: InferSchemaOutput<TParameters>) => Promise<unknown>;
  interrupt?: boolean;
  interruptReason?: string;
  interruptMessage?: string;
})

Source from the content-addressed store, hash-verified

290 * @returns Tool definition
291 */
292export function defineTool<TParameters extends StandardSchemaV1>(config: {
293 name: string;
294 description: string;
295 parameters: TParameters;
296 execute?: (args: InferSchemaOutput<TParameters>) => Promise<unknown>;
297 interrupt?: boolean;
298 interruptReason?: string;
299 interruptMessage?: string;
300}): ToolDefinition<TParameters> {
301 return {
302 name: config.name,
303 description: config.description,
304 parameters: config.parameters,
305 execute: config.execute,
306 interrupt: config.interrupt,
307 interruptReason: config.interruptReason,
308 interruptMessage: config.interruptMessage,
309 };
310}
311
312type AGUIUserMessage = Extract<Message, { role: "user" }>;
313

Callers 11

utils.test.tsFile · 0.90
route.tsFile · 0.85
buildToolsFunction · 0.85
route.tsFile · 0.85
index.tsFile · 0.85
express-runtime.tsFile · 0.85

Calls

no outgoing calls

Tested by

no test coverage detected

Used in the wild real call sites across dependent graphs

searching dependent graphs…