get_service_info

Instructions

Implementation Reference

• src/index.ts:153-207 (handler)

  Executes the 'get_service_info' tool: lists all services by category if no serviceName provided, or details methods of specific service using service.getServiceInfo().

  case 'get_service_info': {
    const serviceName = args?.serviceName as string;
    
    if (serviceName) {
      // Get info for a specific service
      const service = serviceRegistry.getService(serviceName);
      if (!service) {
    return {
      content: [
        {
          type: 'text',
              text: `Service "${serviceName}" not found.\n\nAvailable services: ${serviceRegistry.getServiceNames().join(', ')}`
        }
      ]
    };
  }
  
      const serviceInfo = service.getServiceInfo();
    return {
      content: [
        {
          type: 'text',
            text: `**${serviceInfo.name}** (Category: ${serviceInfo.category})\n\n${serviceInfo.description}\n\n**Available Methods:**\n${serviceInfo.methods.map(m => `• **${m.name}**: ${m.description}`).join('\n')}\n\nUse get_method_info to see detailed parameters for each method.`
          }
        ]
      };
    } else {
      // List all services
      const allServices = serviceRegistry.getAllServiceInfo();
      const servicesByCategory = allServices.reduce((acc, service) => {
        if (!acc[service.category]) acc[service.category] = [];
        acc[service.category].push(service);
        return acc;
      }, {} as Record<string, any[]>);
      
      let output = "**BTCPayServer Services Directory**\n\n";
      for (const [category, services] of Object.entries(servicesByCategory)) {
        output += `**${category.toUpperCase()}:**\n`;
        services.forEach(service => {
          output += `• **${service.name}**: ${service.description} (${service.methods.length} methods)\n`;
        });
        output += '\n';
      }
      output += "Use get_service_info with a specific service name to see available methods.";
      
    return {
      content: [
        {
          type: 'text',
            text: output
        }
      ]
    };
  }
  }

• src/index.ts:88-99 (schema)

  Input schema for 'get_service_info' tool, defining optional 'serviceName' parameter.

    name: 'get_service_info',
    description: 'Discover available BTCPayServer services and their methods. Use this to explore what operations are available.',
    inputSchema: {
      type: 'object',
      properties: {
        serviceName: {
          type: 'string',
          description: 'Optional: Get info for a specific service (e.g., "payment-requests", "invoices", "lightning"). If not provided, lists all services.'
        }
      }
    }
  },

• src/index.ts:83-141 (registration)

  Registers the 'get_service_info' tool in the MCP ListTools response, including its schema.

  this.server.setRequestHandler(ListToolsRequestSchema, async () => {
    return {
      tools: [
        // Service Discovery Tools (Square MCP Pattern)
        {
          name: 'get_service_info',
          description: 'Discover available BTCPayServer services and their methods. Use this to explore what operations are available.',
          inputSchema: {
            type: 'object',
            properties: {
              serviceName: {
                type: 'string',
                description: 'Optional: Get info for a specific service (e.g., "payment-requests", "invoices", "lightning"). If not provided, lists all services.'
              }
            }
          }
        },
        {
          name: 'get_method_info',
          description: 'Get detailed parameter requirements and examples for a specific service method.',
          inputSchema: {
            type: 'object',
            properties: {
              serviceName: {
                type: 'string',
                description: 'Service name (e.g., "payment-requests", "invoices", "lightning")'
              },
              methodName: {
                type: 'string',
                description: 'Method name (e.g., "create", "get", "list", "delete")'
              }
            },
            required: ['serviceName', 'methodName']
          }
        },
        {
          name: 'btcpay_request',
          description: 'Execute a BTCPayServer API operation using the service-based approach.',
          inputSchema: {
            type: 'object',
            properties: {
              serviceName: {
                type: 'string',
                description: 'Service name (e.g., "payment-requests", "invoices", "lightning")'
              },
              methodName: {
                type: 'string',
                description: 'Method name (e.g., "create", "get", "list", "delete")'
              },
              parameters: {
            type: 'object',
                description: 'Parameters for the method (use get_method_info to see required parameters)'
              }
            },
            required: ['serviceName', 'methodName']
          }
        }
      ],
    };