get_user
Retrieve detailed user information from BoldSign using their unique ID to access account details and manage e-signature platform users.
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)Executes the core logic: initializes UserApi with config, calls getUser(userId), and handles response/error using utilities.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 requiring 'userId' (string ID).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)Defines and exports the tool definition (BoldSignTool) with name 'get_user', description, schema, and thin handler delegating to getUserHandler.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)Groups getUserToolDefinition with listUsersToolDefinition for users API tools.export const usersApiToolsDefinitions: BoldSignTool[] = [getUserToolDefinition, listUsersToolDefinition];
- src/tools/index.ts:12-12 (registration)Includes users API tools (containing get_user) in the main tools definitions array....usersApiToolsDefinitions,