Skip to main content
Glama
hidenorigoto

Sakura Cloud MCP Server

by hidenorigoto

get_bill_detail

Retrieve detailed billing information for a specific month from Sakura Cloud infrastructure to analyze costs and manage expenses.

Instructions

Get detailed billing information for a specific month

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
yearYesThe year (YYYY) of the billing period
monthYesThe month (MM) of the billing period

Implementation Reference

  • The handler function within the CallToolRequestSchema that implements the logic for the 'get_bill_detail' tool. It validates credentials, extracts year and month parameters, calls the Sakura Cloud API at `/bill/{year}{month}/detail`, and returns the JSON response.
    } else if (request.params.name === 'get_bill_detail') {
      try {
        validateCredentials();
        
        const year = request.params.arguments?.year as string;
        const month = request.params.arguments?.month as string;
        
        if (!year || !month) {
          throw new Error('Year and month are required for billing details');
        }
        
        const billDetailInfo = await fetchFromSakuraCloud(`/bill/${year}${month}/detail`);
        
        return {
          content: [
            {
              type: 'text',
              text: JSON.stringify(billDetailInfo, null, 2)
            }
          ]
        };
      } catch (error) {
        console.error('Error calling tool:', error);
        throw error;
      }
  • The input schema and metadata for the 'get_bill_detail' tool as returned by the ListToolsRequestSchema handler.
      name: 'get_bill_detail',
      description: 'Get detailed billing information for a specific month',
      inputSchema: {
        type: 'object',
        properties: {
          year: {
            type: 'string',
            description: 'The year (YYYY) of the billing period'
          },
          month: {
            type: 'string',
            description: 'The month (MM) of the billing period'
          }
        },
        required: ['year', 'month']
      }
    },
  • src/server.ts:739-1425 (registration)
    The ListToolsRequestSchema handler registers the 'get_bill_detail' tool by including it in the list of available tools.
    server.setRequestHandler(ListToolsRequestSchema, async () => {
      return {
        tools: [
          {
            name: 'get_server_info',
            description: 'Get detailed information about a specific server',
            inputSchema: {
              type: 'object',
              properties: {
                serverId: {
                  type: 'string',
                  description: 'The ID of the server to retrieve'
                },
                zone: {
                  type: 'string',
                  description: 'The zone to use (e.g., "tk1v", "is1a", "tk1a"). Defaults to "tk1v" if not specified.'
                }
              },
              required: ['serverId']
            }
          },
          {
            name: 'get_server_list',
            description: 'Get list of servers',
            inputSchema: {
              type: 'object',
              properties: {
                zone: {
                  type: 'string',
                  description: 'The zone to use (e.g., "tk1v", "is1a", "tk1a"). Defaults to "tk1v" if not specified.'
                }
              },
            }
          },
          {
            name: 'get_switch_list',
            description: 'Get list of switches',
            inputSchema: {
              type: 'object',
              properties: {
                zone: {
                  type: 'string',
                  description: 'The zone to use (e.g., "tk1v", "is1a", "tk1a"). Defaults to "tk1v" if not specified.'
                }
              },
            }
          },
          {
            name: 'get_switch_info',
            description: 'Get detailed information about a specific switch',
            inputSchema: {
              type: 'object',
              properties: {
                switchId: {
                  type: 'string',
                  description: 'The ID of the switch to retrieve'
                },
                zone: {
                  type: 'string',
                  description: 'The zone to use (e.g., "tk1v", "is1a", "tk1a"). Defaults to "tk1v" if not specified.'
                }
              },
              required: ['switchId']
            }
          },
          {
            name: 'get_appliance_list',
            description: 'Get list of appliances',
            inputSchema: {
              type: 'object',
              properties: {
                zone: {
                  type: 'string',
                  description: 'The zone to use (e.g., "tk1v", "is1a", "tk1a"). Defaults to "tk1v" if not specified.'
                }
              },
            }
          },
          {
            name: 'get_appliance_info',
            description: 'Get detailed information about a specific appliance',
            inputSchema: {
              type: 'object',
              properties: {
                applianceId: {
                  type: 'string',
                  description: 'The ID of the appliance to retrieve'
                }
              },
              required: ['applianceId']
            }
          },
          {
            name: 'get_disk_list',
            description: 'Get list of disks',
            inputSchema: {
              type: 'object',
              properties: {
                zone: {
                  type: 'string',
                  description: 'The zone to use (e.g., "tk1v", "is1a", "tk1a"). Defaults to "tk1v" if not specified.'
                }
              },
            }
          },
          {
            name: 'get_disk_info',
            description: 'Get detailed information about a specific disk',
            inputSchema: {
              type: 'object',
              properties: {
                diskId: {
                  type: 'string',
                  description: 'The ID of the disk to retrieve'
                },
                zone: {
                  type: 'string',
                  description: 'The zone to use (e.g., "tk1v", "is1a", "tk1a"). Defaults to "tk1v" if not specified.'
                }
              },
              required: ['diskId']
            }
          },
          {
            name: 'get_archive_list',
            description: 'Get list of archives',
            inputSchema: {
              type: 'object',
              properties: {
              },
            }
          },
          {
            name: 'get_archive_info',
            description: 'Get detailed information about a specific archive',
            inputSchema: {
              type: 'object',
              properties: {
                archiveId: {
                  type: 'string',
                  description: 'The ID of the archive to retrieve'
                }
              },
              required: ['archiveId']
            }
          },
          {
            name: 'get_cdrom_list',
            description: 'Get list of ISO images',
            inputSchema: {
              type: 'object',
              properties: {
              },
            }
          },
          {
            name: 'get_cdrom_info',
            description: 'Get detailed information about a specific ISO image',
            inputSchema: {
              type: 'object',
              properties: {
                cdromId: {
                  type: 'string',
                  description: 'The ID of the ISO image to retrieve'
                }
              },
              required: ['cdromId']
            }
          },
          {
            name: 'get_bridge_list',
            description: 'Get list of bridges',
            inputSchema: {
              type: 'object',
              properties: {
              },
            }
          },
          {
            name: 'get_bridge_info',
            description: 'Get detailed information about a specific bridge',
            inputSchema: {
              type: 'object',
              properties: {
                bridgeId: {
                  type: 'string',
                  description: 'The ID of the bridge to retrieve'
                }
              },
              required: ['bridgeId']
            }
          },
          {
            name: 'get_router_list',
            description: 'Get list of routers',
            inputSchema: {
              type: 'object',
              properties: {
              },
            }
          },
          {
            name: 'get_router_info',
            description: 'Get detailed information about a specific router',
            inputSchema: {
              type: 'object',
              properties: {
                routerId: {
                  type: 'string',
                  description: 'The ID of the router to retrieve'
                }
              },
              required: ['routerId']
            }
          },
          {
            name: 'get_interface_list',
            description: 'Get list of network interfaces',
            inputSchema: {
              type: 'object',
              properties: {
              },
            }
          },
          {
            name: 'get_interface_info',
            description: 'Get detailed information about a specific network interface',
            inputSchema: {
              type: 'object',
              properties: {
                interfaceId: {
                  type: 'string',
                  description: 'The ID of the interface to retrieve'
                }
              },
              required: ['interfaceId']
            }
          },
          {
            name: 'get_icon_list',
            description: 'Get list of icons',
            inputSchema: {
              type: 'object',
              properties: {
              },
            }
          },
          {
            name: 'get_icon_info',
            description: 'Get detailed information about a specific icon',
            inputSchema: {
              type: 'object',
              properties: {
                iconId: {
                  type: 'string',
                  description: 'The ID of the icon to retrieve'
                }
              },
              required: ['iconId']
            }
          },
          {
            name: 'get_note_list',
            description: 'Get list of notes and startup scripts',
            inputSchema: {
              type: 'object',
              properties: {
              },
            }
          },
          {
            name: 'get_note_info',
            description: 'Get detailed information about a specific note or startup script',
            inputSchema: {
              type: 'object',
              properties: {
                noteId: {
                  type: 'string',
                  description: 'The ID of the note to retrieve'
                }
              },
              required: ['noteId']
            }
          },
          {
            name: 'get_sshkey_list',
            description: 'Get list of SSH keys',
            inputSchema: {
              type: 'object',
              properties: {
              },
            }
          },
          {
            name: 'get_sshkey_info',
            description: 'Get detailed information about a specific SSH key',
            inputSchema: {
              type: 'object',
              properties: {
                sshkeyId: {
                  type: 'string',
                  description: 'The ID of the SSH key to retrieve'
                }
              },
              required: ['sshkeyId']
            }
          },
          {
            name: 'get_region_list',
            description: 'Get list of regions',
            inputSchema: {
              type: 'object',
              properties: {
              },
            }
          },
          {
            name: 'get_region_info',
            description: 'Get detailed information about a specific region',
            inputSchema: {
              type: 'object',
              properties: {
                regionId: {
                  type: 'string',
                  description: 'The ID of the region to retrieve'
                }
              },
              required: ['regionId']
            }
          },
          {
            name: 'get_zone_list',
            description: 'Get list of zones',
            inputSchema: {
              type: 'object',
              properties: {
              },
            }
          },
          {
            name: 'get_zone_info',
            description: 'Get detailed information about a specific zone',
            inputSchema: {
              type: 'object',
              properties: {
                zoneId: {
                  type: 'string',
                  description: 'The ID of the zone to retrieve'
                }
              },
              required: ['zoneId']
            }
          },
          {
            name: 'get_product_info',
            description: 'Get detailed information about specific product offerings',
            inputSchema: {
              type: 'object',
              properties: {
                productType: {
                  type: 'string',
                  description: 'The type of product to retrieve (server, disk, internet, license)',
                  enum: ['server', 'disk', 'internet', 'license']
                }
              },
              required: ['productType']
            }
          },
          {
            name: 'get_commonserviceitem_list',
            description: 'Get list of common service items (DNS, Simple Monitor, etc.)',
            inputSchema: {
              type: 'object',
              properties: {
              },
            }
          },
          {
            name: 'get_commonserviceitem_info',
            description: 'Get detailed information about a specific common service item',
            inputSchema: {
              type: 'object',
              properties: {
                itemId: {
                  type: 'string',
                  description: 'The ID of the common service item to retrieve'
                }
              },
              required: ['itemId']
            }
          },
          {
            name: 'get_license_list',
            description: 'Get list of licenses',
            inputSchema: {
              type: 'object',
              properties: {
              },
            }
          },
          {
            name: 'get_license_info',
            description: 'Get detailed information about a specific license',
            inputSchema: {
              type: 'object',
              properties: {
                licenseId: {
                  type: 'string',
                  description: 'The ID of the license to retrieve'
                }
              },
              required: ['licenseId']
            }
          },
          {
            name: 'get_bill_info',
            description: 'Get billing information for a specific month',
            inputSchema: {
              type: 'object',
              properties: {
                year: {
                  type: 'string',
                  description: 'The year (YYYY) of the billing period'
                },
                month: {
                  type: 'string',
                  description: 'The month (MM) of the billing period'
                }
              },
              required: ['year', 'month']
            }
          },
          {
            name: 'get_bill_detail',
            description: 'Get detailed billing information for a specific month',
            inputSchema: {
              type: 'object',
              properties: {
                year: {
                  type: 'string',
                  description: 'The year (YYYY) of the billing period'
                },
                month: {
                  type: 'string',
                  description: 'The month (MM) of the billing period'
                }
              },
              required: ['year', 'month']
            }
          },
          {
            name: 'get_coupon_info',
            description: 'Get information about a specific coupon',
            inputSchema: {
              type: 'object',
              properties: {
                couponId: {
                  type: 'string',
                  description: 'The ID of the coupon to retrieve'
                }
              },
              required: ['couponId']
            }
          },
          {
            name: 'get_privatehost_info',
            description: 'Get detailed information about a specific private host',
            inputSchema: {
              type: 'object',
              properties: {
                privateHostId: {
                  type: 'string',
                  description: 'The ID of the private host to retrieve'
                }
              },
              required: ['privateHostId']
            }
          },
          {
            name: 'get_public_price',
            description: 'Get public pricing information for Sakura Cloud services',
            inputSchema: {
              type: 'object',
              properties: {}
            }
          },
          {
            name: 'get_apprun_list',
            description: 'Get list of all AppRun applications',
            inputSchema: {
              type: 'object',
              properties: {
                zone: {
                  type: 'string',
                  description: 'The zone to use (e.g., "tk1v", "is1a", "tk1a"). Defaults to "tk1v" if not specified.'
                }
              }
            }
          },
          {
            name: 'get_apprun_info',
            description: 'Get detailed information about a specific AppRun application',
            inputSchema: {
              type: 'object',
              properties: {
                appId: {
                  type: 'string',
                  description: 'The ID of the AppRun application to retrieve'
                },
                zone: {
                  type: 'string',
                  description: 'The zone to use (e.g., "tk1v", "is1a", "tk1a"). Defaults to "tk1v" if not specified.'
                }
              },
              required: ['appId']
            }
          },
          {
            name: 'create_apprun',
            description: 'Create a new AppRun application',
            inputSchema: {
              type: 'object',
              properties: {
                name: {
                  type: 'string',
                  description: 'Name of the AppRun application'
                },
                description: {
                  type: 'string',
                  description: 'Description of the AppRun application'
                },
                dockerImage: {
                  type: 'string',
                  description: 'Docker image to use for the AppRun application'
                },
                planId: {
                  type: 'string',
                  description: 'Plan ID for the AppRun application'
                },
                environment: {
                  type: 'array',
                  description: 'Environment variables for the AppRun application',
                  items: {
                    type: 'object',
                    properties: {
                      key: { type: 'string' },
                      value: { type: 'string' }
                    }
                  }
                },
                zone: {
                  type: 'string',
                  description: 'The zone to use (e.g., "tk1v", "is1a", "tk1a"). Defaults to "tk1v" if not specified.'
                }
              },
              required: ['name', 'dockerImage', 'planId']
            }
          },
          {
            name: 'delete_apprun',
            description: 'Delete an AppRun application',
            inputSchema: {
              type: 'object',
              properties: {
                appId: {
                  type: 'string',
                  description: 'The ID of the AppRun application to delete'
                },
                zone: {
                  type: 'string',
                  description: 'The zone to use (e.g., "tk1v", "is1a", "tk1a"). Defaults to "tk1v" if not specified.'
                }
              },
              required: ['appId']
            }
          },
          {
            name: 'start_apprun',
            description: 'Start an AppRun application',
            inputSchema: {
              type: 'object',
              properties: {
                appId: {
                  type: 'string',
                  description: 'The ID of the AppRun application to start'
                },
                zone: {
                  type: 'string',
                  description: 'The zone to use (e.g., "tk1v", "is1a", "tk1a"). Defaults to "tk1v" if not specified.'
                }
              },
              required: ['appId']
            }
          },
          {
            name: 'stop_apprun',
            description: 'Stop an AppRun application',
            inputSchema: {
              type: 'object',
              properties: {
                appId: {
                  type: 'string',
                  description: 'The ID of the AppRun application to stop'
                },
                zone: {
                  type: 'string',
                  description: 'The zone to use (e.g., "tk1v", "is1a", "tk1a"). Defaults to "tk1v" if not specified.'
                }
              },
              required: ['appId']
            }
          },
          {
            name: 'update_apprun',
            description: 'Update an existing AppRun application',
            inputSchema: {
              type: 'object',
              properties: {
                appId: {
                  type: 'string',
                  description: 'The ID of the AppRun application to update'
                },
                name: {
                  type: 'string',
                  description: 'New name of the AppRun application'
                },
                description: {
                  type: 'string',
                  description: 'New description of the AppRun application'
                },
                dockerImage: {
                  type: 'string',
                  description: 'New Docker image to use for the AppRun application'
                },
                planId: {
                  type: 'string',
                  description: 'New plan ID for the AppRun application'
                },
                environment: {
                  type: 'array',
                  description: 'New environment variables for the AppRun application',
                  items: {
                    type: 'object',
                    properties: {
                      key: { type: 'string' },
                      value: { type: 'string' }
                    }
                  }
                },
                zone: {
                  type: 'string',
                  description: 'The zone to use (e.g., "tk1v", "is1a", "tk1a"). Defaults to "tk1v" if not specified.'
                }
              },
              required: ['appId']
            }
          },
          {
            name: 'get_apprun_logs',
            description: 'Get logs from an AppRun application',
            inputSchema: {
              type: 'object',
              properties: {
                appId: {
                  type: 'string',
                  description: 'The ID of the AppRun application to get logs from'
                },
                offset: {
                  type: 'number',
                  description: 'Offset to start fetching logs from (default: 0)'
                },
                limit: {
                  type: 'number',
                  description: 'Maximum number of log entries to fetch (default: 100)'
                },
                zone: {
                  type: 'string',
                  description: 'The zone to use (e.g., "tk1v", "is1a", "tk1a"). Defaults to "tk1v" if not specified.'
                }
              },
              required: ['appId']
            }
          }
        ]
      };
    });
  • Related resource handler for 'sakura:///bill-detail' which fetches general bill details (without specific year/month).
    } else if (uri === 'sakura:///bill-detail') {
      try {
        validateCredentials();
        const billDetailData = await fetchFromSakuraCloud('/bill/detail');
        
        return {
          contents: [
            {
              uri,
              mimeType: 'application/json',
              text: JSON.stringify(billDetailData, null, 2)
            }
          ]
        };
      } catch (error) {
        console.error('Error fetching billing details:', error);
        throw error;
      }
  • Helper function used by the tool handler to make API calls to Sakura Cloud, handling authentication and HTTPS requests.
    async function fetchFromSakuraCloud(path: string, isPublicAPI: boolean = false, zone: string = DEFAULT_ZONE, method: string = 'GET', bodyData?: any): Promise<any> {
      return new Promise((resolve, reject) => {
        const basePath = isPublicAPI ? '/cloud/api/cloud/1.1' : `/cloud/zone/${zone}/api/cloud/1.1`;
        
        const options = {
          hostname: 'secure.sakura.ad.jp',
          port: 443,
          path: `${basePath}${path}`,
          method: method,
          headers: {
            'Accept': 'application/json',
            'Authorization': '',
            'Content-Type': 'application/json'
          }
        };
        
        // Add authorization for non-public APIs
        if (!isPublicAPI) {
          options.headers['Authorization'] = `Basic ${Buffer.from(`${SACLOUD_API_TOKEN}:${SACLOUD_API_SECRET}`).toString('base64')}`;
        }
    
        const req = https.request(options, (res) => {
          let data = '';
          
          res.on('data', (chunk) => {
            data += chunk;
          });
          
          res.on('end', () => {
            try {
              if (data) {
                const parsedData = JSON.parse(data);
                resolve(parsedData);
              } else {
                resolve({});
              }
            } catch (err) {
              reject(new Error(`Failed to parse response: ${err}`));
            }
          });
        });
        
        req.on('error', (error) => {
          reject(error);
        });
        
        if (bodyData && (method === 'POST' || method === 'PUT')) {
          req.write(JSON.stringify(bodyData));
        }
        
        req.end();
      });
    }
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states the tool retrieves billing information but doesn't mention whether this is a read-only operation, if it requires authentication, rate limits, or what the output format looks like. For a tool with no annotation coverage, this 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.

Conciseness5/5

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

The description is a single, efficient sentence that directly states the tool's purpose without unnecessary words. It's front-loaded with the core action and resource, making it easy to parse quickly, with zero wasted information.

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 lack of annotations and output schema, the description is incomplete for a tool that likely returns complex billing data. It doesn't explain what 'detailed billing information' includes, such as cost breakdowns or usage metrics, leaving the agent uncertain about the tool's full capabilities and output structure.

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?

The input schema has 100% description coverage, clearly documenting the 'year' and 'month' parameters with their formats (YYYY and MM). The description adds no additional parameter semantics beyond what the schema provides, such as examples or constraints, so it meets the baseline score of 3 for high schema coverage.

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

Purpose4/5

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

The description clearly states the tool's purpose with a specific verb ('Get') and resource ('detailed billing information for a specific month'), making it easy to understand what the tool does. However, it doesn't explicitly differentiate from its sibling 'get_bill_info', which might be a similar billing-related tool, leaving some ambiguity about when to use one versus the other.

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?

The description provides no guidance on when to use this tool versus alternatives, such as the sibling 'get_bill_info'. It lacks context on prerequisites, exclusions, or specific scenarios where this tool is preferred, leaving the agent to infer usage based on the name and description alone.

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/hidenorigoto/sacloud-mcp'

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