get_team
Retrieve detailed team information from your BoldSign organization, including team name, users, and creation date, by specifying the unique team ID.
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 implements the core logic of the 'get_team' tool. It creates a TeamsApi instance, sets configuration, calls getTeam with the provided teamId, and handles the response or errors using utility functions.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 for the 'get_team' tool, requiring a teamId.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 that registers the 'get_team' tool, including its method name, description, input schema, and delegates to the handler function.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); }, };