get_template_properties
Retrieve detailed properties and settings for a BoldSign template using its unique template ID to access configuration information.
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 uses the BoldSign TemplateApi to fetch the properties of a specific template by ID, handles the response, and catches 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 for validating the tool input: requires 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.', ), }); type GetTemplatePropertiesSchemaType = z.infer<typeof GetTemplatePropertiesSchema>; - src/tools/templatesTools/getTemplateProperties.ts:17-26 (registration)Defines and exports the tool configuration including method name, description, input schema, and a wrapper handler that delegates to the main 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)Includes the getTemplatePropertiesToolDefinition in the array of templates API tools.
export const templatesApiToolsDefinitions: BoldSignTool[] = [ sendDocumentFromTemplateDynamicToolDefinition, listTemplatesToolDefinition, getTemplatePropertiesToolDefinition, ]; - src/tools/index.ts:8-14 (registration)Top-level aggregation of all tool definitions, spreading the templates API tools (which includes get_template_properties).
export const definitions: BoldSignTool[] = [ ...contactsApiToolsDefinitions, ...documentsApiToolsDefinitions, ...templatesApiToolsDefinitions, ...usersApiToolsDefinitions, ...teamsApiToolsDefinitions, ];