get_contact
Retrieve detailed contact information from your BoldSign organization using the contact ID. Access signer details including email addresses for use in 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
- Executes the core logic of the get_contact tool: initializes ContactsApi with configuration, fetches the contact details by ID using the BoldSign SDK, and handles the MCP response or error.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 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 registering the 'get_contact' tool with MCP, including method name, description, input schema, and wrapper 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)Includes the getContactToolDefinition in the contacts API tools array for further aggregation.export const contactsApiToolsDefinitions: BoldSignTool[] = [ getContactToolDefinition, listContactsToolDefinition, ];
- src/tools/index.ts:8-14 (registration)Top-level aggregation of all tool definitions, spreading contactsApiToolsDefinitions which includes get_contact.export const definitions: BoldSignTool[] = [ ...contactsApiToolsDefinitions, ...documentsApiToolsDefinitions, ...templatesApiToolsDefinitions, ...usersApiToolsDefinitions, ...teamsApiToolsDefinitions, ];