get_team
Retrieve team details, including name, users, and creation/modification dates, by specifying the unique team ID in BoldSign organization. Access team-specific properties for effective management.
Instructions
Retrieve detailed information about an existing team in your BoldSign organization. This API provides access to team-specific properties, such as team name, users, created date, and modified date, by specifying the unique team ID.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| teamId | Yes | Required. The unique identifier (ID) of the team to retrieve. This can be obtained from the list teams tool. |
Implementation Reference
- src/tools/teamsTools/getTeam.ts:28-40 (handler)The handler function that executes the tool logic: creates TeamsApi instance, calls getTeam with teamId, and returns formatted response or error.async function getTeamHandler(payload: GetTeamSchemaType): Promise<McpResponse> { try { const teamsApi = new TeamsApi(); teamsApi.basePath = configuration.getBasePath(); teamsApi.setApiKey(configuration.getApiKey()); const teamResponse: TeamResponse = await teamsApi.getTeam(payload.teamId); return handleMcpResponse({ data: teamResponse, }); } catch (error: any) { return handleMcpError(error); } }
- src/tools/teamsTools/getTeam.ts:9-13 (schema)Zod schema defining the input: teamId (required string ID).const GetTeamSchema = z.object({ teamId: commonSchema.InputIdSchema.describe( 'Required. The unique identifier (ID) of the team to retrieve. This can be obtained from the list teams tool.', ), });
- src/tools/teamsTools/getTeam.ts:17-26 (registration)Tool definition object with method name 'get_team', description, input schema, and handler wrapper that calls the main handler.export const getTeamToolDefinition: BoldSignTool = { method: ToolNames.GetTeam.toString(), name: 'Get team', description: 'Retrieve detailed information about an existing team in your BoldSign organization. This API provides access to team-specific properties, such as team name, users, created date, and modified date, by specifying the unique team ID.', inputSchema: GetTeamSchema, async handler(args: unknown): Promise<McpResponse> { return await getTeamHandler(args as GetTeamSchemaType); }, };
- src/tools/index.ts:8-14 (registration)Central registry of all BoldSign tools, spreading in teamsApiToolsDefinitions (which includes get_team) for MCP tool registration.export const definitions: BoldSignTool[] = [ ...contactsApiToolsDefinitions, ...documentsApiToolsDefinitions, ...templatesApiToolsDefinitions, ...usersApiToolsDefinitions, ...teamsApiToolsDefinitions, ];
- src/tools/toolNames.ts:33-33 (helper)Enum defining the tool method name 'get_team' used in tool definitions.GetTeam = 'get_team',