BoldSign MCP Server

Instructions

Implementation Reference

• src/tools/teamsTools/getTeam.ts:28-40 (handler)

  Core handler function that initializes the BoldSign TeamsApi client, retrieves the team by ID, and returns a formatted McpResponse or handles errors.

  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 parameters for the get_team tool: requires a teamId string.

  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 registered as BoldSignTool with method 'get_team', description, input schema, and wrapper handler calling the core getTeamHandler.

  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 collection of all tool definitions, including the teams tools (which contain get_team), exported for use in MCP server.

  export const definitions: BoldSignTool[] = [
    ...contactsApiToolsDefinitions,
    ...documentsApiToolsDefinitions,
    ...templatesApiToolsDefinitions,
    ...usersApiToolsDefinitions,
    ...teamsApiToolsDefinitions,
  ];

• src/index.ts:22-60 (registration)

  MCP server request handlers for ListTools (exposes get_team via definitions) and CallTool (executes get_team handler by method name matching).

  server.setRequestHandler(ListToolsRequestSchema, async () => ({
    tools: definitions.map((toolDefinition: BoldSignTool) => {
      return {
        name: toolDefinition.method,
        description: toolDefinition.description,
        inputSchema: zodToJsonSchema(toolDefinition.inputSchema),
      };
    }),
  }));
  
  server.setRequestHandler(CallToolRequestSchema, async (request) => {
    const toolName = request.params.name;
    const tool = definitions.find((t) => t.method === toolName);
  
    if (!tool) {
      throw new McpError(ErrorCode.MethodNotFound, `Unknown tool: ${toolName}`);
    }
  
    const args = request.params.arguments;
    const schemaResult = tool.inputSchema.safeParse(args);
  
    if (!schemaResult.success) {
      throw new McpError(
        ErrorCode.InvalidParams,
        `Invalid parameters for tool ${toolName}: ${schemaResult.error.message}`,
      );
    }
  
    try {
      const result = await tool.handler(args);
      return {
        content: [{ type: 'text', text: `${toJsonString(result)}` }],
      };
    } catch (error) {
      console.error('[Error] Failed to fetch data:', error);
      const errorMessage = error instanceof Error ? error.message : String(error);
      throw new McpError(ErrorCode.InternalError, `API error: ${errorMessage}`);
    }
  });