get_template_properties
Retrieve detailed properties and settings of a specific BoldSign template by providing its unique template ID for precise management and configuration.
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 core handler function that creates a TemplateApi instance, sets configuration, fetches template properties by ID from BoldSign API, and handles response or errors.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 schema defining the input parameters, specifically requiring a templateId.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 object registering the tool with MCP, including method name, description, input schema, and a delegating 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)Aggregates template-related tool definitions, including getTemplatePropertiesToolDefinition, likely for batch registration.export const templatesApiToolsDefinitions: BoldSignTool[] = [ sendDocumentFromTemplateDynamicToolDefinition, listTemplatesToolDefinition, getTemplatePropertiesToolDefinition, ];
- src/tools/toolNames.ts:79-79 (helper)Enum defining the tool name constant used in registration.GetTemplateProperties = 'get_template_properties',