get_user
Retrieve detailed user information in BoldSign by specifying the user's unique ID. Useful for managing user data and permissions efficiently.
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:9-15 (schema)Zod schema for validating input to the get_user tool, which requires 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.', ), }); type GetUserSchemaType = z.infer<typeof GetUserSchema>;
- src/tools/usersTools/getUser.ts:27-39 (handler)Core handler function that instantiates BoldSign UserApi, fetches user by ID, and returns formatted response or handles errors.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:17-25 (registration)Tool definition exporting the get_user tool with method name, description, schema, and wrapper handler for MCP.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)Includes getUserToolDefinition in the users API tools array for further aggregation.export const usersApiToolsDefinitions: BoldSignTool[] = [getUserToolDefinition, listUsersToolDefinition];
- src/tools/index.ts:8-14 (registration)Main tools index aggregating all API tool definitions, including usersApiToolsDefinitions containing get_user.export const definitions: BoldSignTool[] = [ ...contactsApiToolsDefinitions, ...documentsApiToolsDefinitions, ...templatesApiToolsDefinitions, ...usersApiToolsDefinitions, ...teamsApiToolsDefinitions, ];