BoldSign MCP Server

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

src/tools/templatesTools/getTemplateProperties.ts:28-40 (handler)

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);
  }
}

src/tools/templatesTools/getTemplateProperties.ts:9-13 (schema)

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',
```

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedv1.0.0Jan 3, 2026
- addedInput schema / $schema
```
Added value: +"http://json-schema.org/draft-07/schema#"
```
- addedInput schema / additionalProperties
```
Added value: +false
```
First observedOct 1, 2025

TDQS

A3.9/5.0

Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It indicates this is a read operation ('Retrieves'), which is clear, but lacks details on permissions, rate limits, error handling, or output format. It adds minimal context beyond the basic action, leaving gaps in behavioral understanding.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, well-structured sentence that efficiently conveys the tool's purpose and key usage note. It is front-loaded with the main action and resource, with no wasted words, making it easy to parse quickly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's low complexity (1 parameter, no output schema, no annotations), the description is adequate but incomplete. It covers the basic purpose and parameter sourcing, but lacks details on behavioral aspects like authentication needs or return values, which are important for a tool with no structured output schema.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, with the single parameter 'templateId' fully documented in the schema. The description adds marginal value by reinforcing that the ID is 'unique' and can be 'obtained from the list templates tool,' but does not provide additional semantics beyond what the schema already covers.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Retrieves'), the resource ('detailed properties and settings of a specific BoldSign template'), and the key identifier ('using its unique template ID'). It distinguishes this tool from siblings like 'list_templates' by focusing on individual template details rather than listing multiple templates.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage context by specifying 'a specific BoldSign template using its unique template ID,' suggesting this tool is for detailed lookup after obtaining an ID from 'list_templates.' However, it does not explicitly state when not to use it or name alternatives, leaving some ambiguity compared to other get_* tools.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server