Skip to main content
Glama
max-paulus

gong-mcp

by max-paulus

postv2callsextensive

Retrieve filtered call data with detailed content and participant information from Gong's MCP server for analysis and insights.

Instructions

Filtered call list with rich payload

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
requestBodyYesThe JSON request body.

Implementation Reference

  • Generic handler function that executes all API tools, including 'postv2callsextensive'. Validates tool arguments using a Zod schema derived from the tool's inputSchema, constructs the API request URL for POST /v2/calls/extensive, adds Basic Auth header using GONG_ACCESS_KEY and GONG_SECRET environment variables, sends the requestBody as JSON, and returns the API response as formatted JSON text.
    async function executeApiTool(
        toolName: string,
        definition: McpToolDefinition,
        toolArgs: JsonObject,
        allSecuritySchemes: Record<string, any>
    ): Promise<CallToolResult> {
        try {
            // Validate input arguments using Zod
            const zodSchema = getZodSchemaFromJsonSchema(definition.inputSchema, toolName);
            const validatedArgs = zodSchema.parse(toolArgs);
    
            // Build the request URL
            let url = API_BASE_URL + definition.pathTemplate;
            
            // Replace path parameters
            for (const param of definition.executionParameters) {
                if (param.in === 'path') {
                    const value = validatedArgs[param.name];
                    if (value !== undefined) {
                        url = url.replace(`{${param.name}}`, encodeURIComponent(value));
                    }
                }
            }
    
            // Build query parameters
            const queryParams: Record<string, string> = {};
            for (const param of definition.executionParameters) {
                if (param.in === 'query') {
                    const value = validatedArgs[param.name];
                    if (value !== undefined) {
                        queryParams[param.name] = value;
                    }
                }
            }
            
            if (Object.keys(queryParams).length > 0) {
                url += '?' + new URLSearchParams(queryParams).toString();
            }
    
            // Debug logging (safe)
            console.error('Debug - Making API request to:', url);
            
            // Get credentials from environment
            const accessKey = process.env.GONG_ACCESS_KEY || '';
            const secret = process.env.GONG_SECRET || '';
            
            if (!accessKey || !secret) {
                throw new Error('Missing Gong credentials in environment');
            }
            
            // Create authorization header
            const authHeader = `Basic ${Buffer.from(`${accessKey}:${secret}`).toString('base64')}`;
            
            // Build request config
            const config: AxiosRequestConfig = {
                method: definition.method,
                url,
                headers: {
                    'Accept': 'application/json',
                    'Authorization': authHeader
                }
            };
    
            // Add request body if needed
            if (definition.requestBodyContentType) {
                config.headers!['Content-Type'] = definition.requestBodyContentType;
                if (validatedArgs.requestBody) {
                    config.data = validatedArgs.requestBody;
                }
            }
    
            // Make the request
            const response = await axios(config);
            
            return {
                content: [
                    {
                        type: 'text',
                        text: JSON.stringify(response.data, null, 2)
                    }
                ]
            };
    
        } catch (error: any) {
            if (error instanceof ZodError) {
                return {
                    content: [{
                        type: 'text',
                        text: `Validation error: ${error.message}`
                    }]
                };
            }
            
            if (axios.isAxiosError(error)) {
                return {
                    content: [{
                        type: 'text',
                        text: formatApiError(error)
                    }]
                };
            }
    
            return {
                content: [{
                    type: 'text',
                    text: `Unexpected error: ${error.message}`
                }]
            };
        }
    }
  • src/index.ts:70-79 (registration)
    Tool registration in the toolDefinitionMap. Specifies the tool name, description, input JSON schema (requiring requestBody with filter, contentSelector, cursor), POST method, path template "/v2/calls/extensive", JSON request body, and basicAuth security.
    ["postv2callsextensive", {
      name: "postv2callsextensive",
      description: `Filtered call list with rich payload`,
      inputSchema: {"type":"object","properties":{"requestBody":{"type":"object","required":["filter"],"properties":{"filter":{"type":"object","properties":{"fromDateTime":{"type":"string","format":"date-time"},"toDateTime":{"type":"string","format":"date-time"},"callIds":{"type":"array","items":{"type":"string"}},"primaryUserIds":{"type":"array","items":{"type":"string"}},"participantsEmails":{"type":"array","items":{"type":"string","format":"email"}}}},"contentSelector":{"type":"object","properties":{"context":{"type":"string","enum":["None","Extended"]},"contextTiming":{"type":"array","items":{"type":"string","enum":["Now","TimeOfCall"]}},"exposedFields":{"type":"object","additionalProperties":{"type":"object"}}}},"cursor":{"type":"string"}},"description":"The JSON request body."}},"required":["requestBody"]},
      method: "post",
      pathTemplate: "/v2/calls/extensive",
      executionParameters: [],
      requestBodyContentType: "application/json",
      securityRequirements: [{"basicAuth":[]}]
    }],
  • JSON input schema for the tool, defining the structure of the requestBody parameter (with filter for date range, call/participant IDs/emails, contentSelector for context and fields, and cursor for pagination).
      inputSchema: {"type":"object","properties":{"requestBody":{"type":"object","required":["filter"],"properties":{"filter":{"type":"object","properties":{"fromDateTime":{"type":"string","format":"date-time"},"toDateTime":{"type":"string","format":"date-time"},"callIds":{"type":"array","items":{"type":"string"}},"primaryUserIds":{"type":"array","items":{"type":"string"}},"participantsEmails":{"type":"array","items":{"type":"string","format":"email"}}}},"contentSelector":{"type":"object","properties":{"context":{"type":"string","enum":["None","Extended"]},"contextTiming":{"type":"array","items":{"type":"string","enum":["Now","TimeOfCall"]}},"exposedFields":{"type":"object","additionalProperties":{"type":"object"}}}},"cursor":{"type":"string"}},"description":"The JSON request body."}},"required":["requestBody"]},
      method: "post",
      pathTemplate: "/v2/calls/extensive",
      executionParameters: [],
      requestBodyContentType: "application/json",
      securityRequirements: [{"basicAuth":[]}]
    }],
  • Helper function that converts the tool's JSON inputSchema to a runtime Zod schema using json-schema-to-zod library and eval, used for input validation in the handler.
    function getZodSchemaFromJsonSchema(jsonSchema: any, toolName: string): z.ZodTypeAny {
        if (typeof jsonSchema !== 'object' || jsonSchema === null) { 
            return z.object({}).passthrough(); 
        }
        try {
            const zodSchemaString = jsonSchemaToZod(jsonSchema);
            const zodSchema = eval(zodSchemaString);
            if (typeof zodSchema?.parse !== 'function') { 
                throw new Error('Eval did not produce a valid Zod schema.'); 
            }
            return zodSchema as z.ZodTypeAny;
        } catch (err: any) {
            console.error(`Failed to generate/evaluate Zod schema for '${toolName}':`, err);
            return z.object({}).passthrough();
        }
    }
  • MCP server dispatcher for tool calls: retrieves tool definition from map by name and delegates to executeApiTool.
    server.setRequestHandler(CallToolRequestSchema, async (request: CallToolRequest): Promise<CallToolResult> => {
      const { name: toolName, arguments: toolArgs } = request.params;
      const toolDefinition = toolDefinitionMap.get(toolName);
      if (!toolDefinition) {
        console.error(`Error: Unknown tool requested: ${toolName}`);
        return { content: [{ type: "text", text: `Error: Unknown tool requested: ${toolName}` }] };
      }
      return await executeApiTool(toolName, toolDefinition, toolArgs ?? {}, securitySchemes);
    });
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It mentions 'rich payload' but doesn't explain what that entails (e.g., data format, pagination, rate limits, or authentication needs). For a tool with complex filtering and content selection parameters, this lack of detail is a significant gap in transparency.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that is front-loaded with key information ('Filtered call list'). However, it could be more structured by explicitly stating the verb (e.g., 'Retrieve') and separating purpose from output details for better clarity.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity (multiple nested parameters, no output schema, and no annotations), the description is incomplete. It doesn't address the tool's behavior, output format, or error handling, leaving the agent with insufficient context to use it effectively beyond what the input schema provides.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema fully documents the parameters (e.g., filter fields like fromDateTime, contentSelector options). The description adds no additional meaning beyond the schema, such as explaining parameter interactions or usage examples, but the baseline score of 3 is appropriate since the schema does the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Filtered call list with rich payload' states the purpose (filtering calls) and hints at the output ('rich payload'), but it's vague about what 'rich payload' means and doesn't distinguish this tool from its sibling 'postv2callstranscript' which also deals with calls. It lacks a specific verb and clear resource scope differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives like 'getv2callsbyid' or 'postv2callstranscript'. The description implies filtering capabilities but doesn't specify scenarios, prerequisites, or exclusions for usage, leaving the agent without contextual direction.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/max-paulus/gong-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server