get_template_properties
Retrieve detailed properties and settings for a specific BoldSign e-signature template using its unique template ID.
Instructions
Retrieves the detailed properties and settings of a specific BoldSign template using its unique template ID.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| templateId | Yes | Required. The unique identifier (ID) of the template to retrieve. This can be obtained from the list templates tool. |
Implementation Reference
- The main handler function that executes the tool logic: creates TemplateApi, sets config, calls getProperties API, handles response/error.
async function getTemplatePropertiesHandler(payload: GetTemplatePropertiesSchemaType): Promise<McpResponse> { try { const templateApi = new TemplateApi(); templateApi.basePath = configuration.getBasePath(); templateApi.setApiKey(configuration.getApiKey()); const templateProperties: TemplateProperties = await templateApi.getProperties(payload.templateId); return handleMcpResponse({ data: templateProperties, }); } catch (error: any) { return handleMcpError(error); } } - Zod input schema validating the required templateId parameter.
const GetTemplatePropertiesSchema = z.object({ templateId: commonSchema.InputIdSchema.describe( 'Required. The unique identifier (ID) of the template to retrieve. This can be obtained from the list templates tool.', ), }); - src/tools/templatesTools/getTemplateProperties.ts:17-26 (registration)Tool definition registering the tool with MCP: specifies method name, description, input schema, and delegates to the handler.
export const getTemplatePropertiesToolDefinition: BoldSignTool = { method: ToolNames.GetTemplateProperties.toString(), name: 'Get template properties', description: 'Retrieves the detailed properties and settings of a specific BoldSign template using its unique template ID.', inputSchema: GetTemplatePropertiesSchema, async handler(args: unknown): Promise<McpResponse> { return await getTemplatePropertiesHandler(args as GetTemplatePropertiesSchemaType); }, }; - src/tools/templatesTools/index.ts:6-10 (registration)Registration in templates tools array, which is later included in main tools.
export const templatesApiToolsDefinitions: BoldSignTool[] = [ sendDocumentFromTemplateDynamicToolDefinition, listTemplatesToolDefinition, getTemplatePropertiesToolDefinition, ]; - src/tools/toolNames.ts:79-79 (helper)Enum value defining the tool's string identifier.
GetTemplateProperties = 'get_template_properties',