Skip to main content

getSchema

client.codeboltTools.getSchema(toolName: string): Promise<CodeboltToolSchema>

Retrieves the JSON schema for a specific tool.

Returns the schema definition that describes the tool's input structure, required parameters, and validation rules. Useful for building dynamic UI forms or validating tool inputs before execution.

Parameters​

ParameterTypeRequiredDescription
toolNamestringYesThe name of the tool to get schema for

Returns​

Promise<CodeboltToolSchema> — A promise that resolves to the CodeboltToolSchema object

Example​

import { CodeBoltClient } from '@codebolt/clientsdk';

const client = new CodeBoltClient();

const result = await client.codeboltTools.getSchema('toolName');
console.log(result);