get_user
Retrieve detailed user information from BoldSign using their unique ID to manage e-signature workflows and user data.
Instructions
Retrieves detailed information for a specific BoldSign user based on their unique user ID.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | Required. The unique identifier (ID) of the user to retrieve. This can be obtained from the list users tool. |
Implementation Reference
- src/tools/usersTools/getUser.ts:27-39 (handler)The core handler function implementing the logic for the 'get_user' tool. It initializes the BoldSign UserApi client with configuration and retrieves user properties by userId.
async function getUserHandler(payload: GetUserSchemaType): Promise<McpResponse> { try { const userApi = new UserApi(); userApi.basePath = configuration.getBasePath(); userApi.setApiKey(configuration.getApiKey()); const userProperties: UserProperties = await userApi.getUser(payload.userId); return handleMcpResponse({ data: userProperties, }); } catch (error: any) { return handleMcpError(error); } } - src/tools/usersTools/getUser.ts:9-13 (schema)Zod input schema validation for the 'get_user' tool, requiring a userId.
const GetUserSchema = z.object({ userId: commonSchema.InputIdSchema.describe( 'Required. The unique identifier (ID) of the user to retrieve. This can be obtained from the list users tool.', ), }); - src/tools/usersTools/getUser.ts:17-25 (registration)Tool definition object for 'get_user', specifying name, description, schema, and handler wrapper. The method is set to 'get_user' from ToolNames.
export const getUserToolDefinition: BoldSignTool = { method: ToolNames.GetUser.toString(), name: 'Get user', description: 'Retrieves detailed information for a specific BoldSign user based on their unique user ID.', inputSchema: GetUserSchema, async handler(args: unknown): Promise<McpResponse> { return await getUserHandler(args as GetUserSchemaType); }, }; - src/tools/usersTools/index.ts:5-5 (registration)Registration of users API tools array, including the getUserToolDefinition.
export const usersApiToolsDefinitions: BoldSignTool[] = [getUserToolDefinition, listUsersToolDefinition]; - src/tools/index.ts:8-14 (registration)Top-level registration of all BoldSign tools, spreading usersApiToolsDefinitions which includes 'get_user'.
export const definitions: BoldSignTool[] = [ ...contactsApiToolsDefinitions, ...documentsApiToolsDefinitions, ...templatesApiToolsDefinitions, ...usersApiToolsDefinitions, ...teamsApiToolsDefinitions, ];