get_contact
Retrieve specific contact details using a unique ID for signer information in BoldSign. Ideal for managing document signatures and ensuring accurate signer data.
Instructions
This tool utilizes the BoldSign API to retrieve detailed information for a specific contact within your organization. To use this tool, you need to provide the unique identifier (ID) of the contact you wish to retrieve. Contacts are primarily used to store signer details, identified by their unique email address, for use when creating and sending documents for signature within the BoldSign application.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Required. The unique identifier (ID) of the contact to retrieve. This can be obtained from the list contacts tool. |
Implementation Reference
- Core handler function that creates ContactsApi instance, configures it, fetches contact details by ID, and returns formatted McpResponse or handles errors.async function getContactHandler(payload: GetContactSchemaType): Promise<McpResponse> { try { const contactsApi = new ContactsApi(); contactsApi.basePath = configuration.getBasePath(); contactsApi.setApiKey(configuration.getApiKey()); const contactsDetails: ContactsDetails = await contactsApi.getContact(payload.id); return handleMcpResponse({ data: contactsDetails, }); } catch (error: any) { return handleMcpError(error); } }
- Zod schema for validating input parameters, requiring a contact ID.const GetContactSchema = z.object({ id: commonSchema.InputIdSchema.describe( 'Required. The unique identifier (ID) of the contact to retrieve. This can be obtained from the list contacts tool.', ), });
- src/tools/contactsTools/getContact.ts:17-26 (registration)Tool definition exporting the 'get_contact' tool with method name, description, input schema, and handler wrapper.export const getContactToolDefinition: BoldSignTool = { method: ToolNames.GetContact.toString(), name: 'Get contact', description: 'This tool utilizes the BoldSign API to retrieve detailed information for a specific contact within your organization. To use this tool, you need to provide the unique identifier (ID) of the contact you wish to retrieve. Contacts are primarily used to store signer details, identified by their unique email address, for use when creating and sending documents for signature within the BoldSign application.', inputSchema: GetContactSchema, async handler(args: unknown): Promise<McpResponse> { return await getContactHandler(args as GetContactSchemaType); }, };
- src/tools/contactsTools/index.ts:5-8 (registration)Registers getContactToolDefinition in the contacts API tools array.export const contactsApiToolsDefinitions: BoldSignTool[] = [ getContactToolDefinition, listContactsToolDefinition, ];
- src/tools/index.ts:2-14 (registration)Global tool definitions array that includes all API tools, spreading contactsApiToolsDefinitions which contains get_contact.import { contactsApiToolsDefinitions } from './contactsTools/index.js'; import { documentsApiToolsDefinitions } from './documentsTools/index.js'; import { teamsApiToolsDefinitions } from './teamsTools/index.js'; import { templatesApiToolsDefinitions } from './templatesTools/index.js'; import { usersApiToolsDefinitions } from './usersTools/index.js'; export const definitions: BoldSignTool[] = [ ...contactsApiToolsDefinitions, ...documentsApiToolsDefinitions, ...templatesApiToolsDefinitions, ...usersApiToolsDefinitions, ...teamsApiToolsDefinitions, ];