get_contact
Retrieve detailed contact information from BoldSign using the contact's unique ID to access signer details for document signing workflows.
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
- The main handler function that creates a ContactsApi instance, configures it with base path and API key, fetches the contact details by ID, and returns a 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 defining the input for the get_contact tool, 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 object that registers the 'get_contact' tool with its method name, description, input schema, and a wrapper handler delegating to the main handler.
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)Array that includes the getContactToolDefinition as part of contacts API tools, which is further aggregated into the main tools list.
export const contactsApiToolsDefinitions: BoldSignTool[] = [ getContactToolDefinition, listContactsToolDefinition, ]; - src/tools/index.ts:8-14 (registration)Main tools definitions array that spreads contactsApiToolsDefinitions, making get_contact available to the MCP server.
export const definitions: BoldSignTool[] = [ ...contactsApiToolsDefinitions, ...documentsApiToolsDefinitions, ...templatesApiToolsDefinitions, ...usersApiToolsDefinitions, ...teamsApiToolsDefinitions, ];