list_users
Retrieve a paginated list of BoldSign users with optional search filtering to manage e-signature platform access and permissions.
Instructions
Retrieves a paginated list of BoldSign users, with optional filtering by a search term.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pageSize | Yes | ||
| page | Yes | ||
| search | No | Optional. A string used to filter the user list. The API will return contacts whose details contain this search term. |
Implementation Reference
- src/tools/usersTools/listUsers.ts:29-45 (handler)Executes the list_users tool by creating a UserApi instance, configuring it, calling the BoldSign API's listUsers method with pagination and search parameters, and handling the response or error.
async function listUsersHandler(payload: ListUsersSchemaType): Promise<McpResponse> { try { const userApi = new UserApi(); userApi.basePath = configuration.getBasePath(); userApi.setApiKey(configuration.getApiKey()); const userRecords: UserRecords = await userApi.listUsers( payload.page, payload.pageSize ?? undefined, payload.search ?? undefined, ); return handleMcpResponse({ data: userRecords, }); } catch (error: any) { return handleMcpError(error); } } - Zod schema for validating input to the list_users tool: pageSize (1-100), page (default 1), optional search string.
const ListUsersSchema = z.object({ pageSize: z.number().int().min(1).max(100), page: z.number().int().min(1).default(1), search: commonSchema.OptionalStringSchema.describe( 'Optional. A string used to filter the user list. The API will return contacts whose details contain this search term.', ), }); - src/tools/usersTools/listUsers.ts:19-27 (registration)Tool definition object for 'list_users', specifying method name, description, input schema, and wrapper handler calling the main listUsersHandler.
export const listUsersToolDefinition: BoldSignTool = { method: ToolNames.ListUsers.toString(), name: 'List users', description: 'Retrieves a paginated list of BoldSign users, with optional filtering by a search term.', inputSchema: ListUsersSchema, async handler(args: unknown): Promise<McpResponse> { return await listUsersHandler(args as ListUsersSchemaType); }, }; - src/tools/usersTools/index.ts:1-5 (registration)Collects and exports users API tools definitions, including listUsersToolDefinition, as an array.
import { getUserToolDefinition } from '../../tools/usersTools/getUser.js'; import { listUsersToolDefinition } from '../../tools/usersTools/listUsers.js'; import { BoldSignTool } from '../../utils/types.js'; export const usersApiToolsDefinitions: BoldSignTool[] = [getUserToolDefinition, listUsersToolDefinition]; - src/tools/index.ts:6-14 (registration)Imports users API tools and includes them in the central definitions array used for MCP tool registration.
import { usersApiToolsDefinitions } from './usersTools/index.js'; export const definitions: BoldSignTool[] = [ ...contactsApiToolsDefinitions, ...documentsApiToolsDefinitions, ...templatesApiToolsDefinitions, ...usersApiToolsDefinitions, ...teamsApiToolsDefinitions, ];