Square Model Context Protocol Server

Instructions

Implementation Reference

• server.ts:297-333 (handler)

  Handler function for the 'get_service_info' tool. It retrieves method information for a given Square API service and returns descriptions of available methods.

  async (params) => {
    try {
      const { service } = params;
      const serviceName = service.charAt(0).toUpperCase() + service.slice(1);
      
      const methods = serviceMethodsMap[serviceName];
      if (!methods) {
        throw new Error(`Invalid service: ${service}. Available services: ${JSON.stringify(Object.keys(serviceMethodsMap), null, 2)}`);
      }
  
      // Create a map of method names to their descriptions
      const methodInfo = Object.entries(methods).reduce((acc, [methodName, info]) => {
        acc[methodName] = {
          description: info.description
        };
        return acc;
      }, {} as Record<string, { description: string }>);
  
      return {
        content: [{
          type: "text",
          text: JSON.stringify(methodInfo, null, 2)
        }]
      };
    } catch (err: any) {
      return {
        content: [{
          type: "text",
          text: JSON.stringify({
            error: err.message,
            details: err.errors || err.stack
          }, null, 2)
        }],
        isError: true
      };
    }
  }

• server.ts:294-296 (schema)

  Input schema for the 'get_service_info' tool, defining the 'service' parameter using Zod.

  {
    service: z.string().describe("The Square API service category (e.g., 'catalog', 'payments')")
  },

• server.ts:291-334 (registration)

  Registration of the 'get_service_info' MCP tool using server.tool, including description, schema, and inline handler.

  server.tool(
    "get_service_info",
    "Get information about a Square API service. Call me before trying to get type info",
    {
      service: z.string().describe("The Square API service category (e.g., 'catalog', 'payments')")
    },
    async (params) => {
      try {
        const { service } = params;
        const serviceName = service.charAt(0).toUpperCase() + service.slice(1);
        
        const methods = serviceMethodsMap[serviceName];
        if (!methods) {
          throw new Error(`Invalid service: ${service}. Available services: ${JSON.stringify(Object.keys(serviceMethodsMap), null, 2)}`);
        }
  
        // Create a map of method names to their descriptions
        const methodInfo = Object.entries(methods).reduce((acc, [methodName, info]) => {
          acc[methodName] = {
            description: info.description
          };
          return acc;
        }, {} as Record<string, { description: string }>);
  
        return {
          content: [{
            type: "text",
            text: JSON.stringify(methodInfo, null, 2)
          }]
        };
      } catch (err: any) {
        return {
          content: [{
            type: "text",
            text: JSON.stringify({
              error: err.message,
              details: err.errors || err.stack
            }, null, 2)
          }],
          isError: true
        };
      }
    }
  );