get_user
Retrieve detailed user information from BoldSign by providing a unique user ID to access account data and profile details.
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, fetches the user properties by ID, and returns an McpResponse.
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 schema defining the input parameters for the 'get_user' tool, specifically 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 that registers the 'get_user' tool, specifying its method name, description, input schema, and wrapper handler.
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)Registers the getUserToolDefinition as part of the users API tools array.
export const usersApiToolsDefinitions: BoldSignTool[] = [getUserToolDefinition, listUsersToolDefinition]; - src/tools/index.ts:8-14 (registration)Main tool definitions array that includes the users API tools (containing 'get_user') for overall MCP tool registration.
export const definitions: BoldSignTool[] = [ ...contactsApiToolsDefinitions, ...documentsApiToolsDefinitions, ...templatesApiToolsDefinitions, ...usersApiToolsDefinitions, ...teamsApiToolsDefinitions, ];