Skip to main content
Glama
hidenorigoto

Sakura Cloud MCP Server

by hidenorigoto

get_appliance_info

Retrieve detailed information about a specific Sakura Cloud appliance by providing its ID to manage infrastructure components.

Instructions

Get detailed information about a specific appliance

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
applianceIdYesThe ID of the appliance to retrieve

Implementation Reference

  • Handler for the 'get_appliance_info' tool. Validates credentials, extracts applianceId (required) and optional zone (defaults to 'tk1v'), fetches data from Sakura Cloud API endpoint '/appliance/{applianceId}', and returns the JSON-stringified response as text content.
    } else if (request.params.name === 'get_appliance_info') {
      try {
        validateCredentials();
        
        const applianceId = request.params.arguments?.applianceId as string;
        if (!applianceId) {
          throw new Error('Appliance ID is required');
        }
        
        const zone = request.params.arguments?.zone as string || DEFAULT_ZONE;
        const applianceInfo = await fetchFromSakuraCloud(`/appliance/${applianceId}`, false, zone);
        
        return {
          content: [
            {
              type: 'text',
              text: JSON.stringify(applianceInfo, null, 2)
            }
          ]
        };
      } catch (error) {
        console.error('Error calling tool:', error);
        throw error;
      }
  • src/server.ts:817-830 (registration)
    Registration of the 'get_appliance_info' tool in ListToolsRequestSchema handler, including its description and input schema (requires applianceId string).
    {
      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']
      }
    },
  • Core helper function used by the tool to make authenticated HTTPS requests to Sakura Cloud API, constructing the path with zone, handling Basic Auth with env vars, parsing JSON response.
    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();
      });
    }
  • Helper function called by the handler to ensure API credentials are set in environment variables.
    function validateCredentials(): void {
      if (!SACLOUD_API_TOKEN || !SACLOUD_API_SECRET) {
        throw new Error('Missing API credentials. Set SACLOUD_API_TOKEN and SACLOUD_API_SECRET environment variables.');
      }
    }
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 information, implying a read-only operation, but doesn't specify aspects like authentication requirements, rate limits, error handling, or what 'detailed information' includes (e.g., fields returned). This leaves significant gaps for a tool with no annotation coverage.

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 is front-loaded with the core action ('Get detailed information'), making it easy to parse. There is zero waste, earning a top score for conciseness.

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 no annotations, no output schema, and a simple parameter with full schema coverage, the description is incomplete. It lacks details on behavioral traits (e.g., safety, performance) and output format, which are critical for a read operation. While the parameter is covered, overall context is insufficient for effective tool use.

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, with the parameter 'applianceId' documented as 'The ID of the appliance to retrieve'. The description adds no additional meaning beyond this, such as format examples or constraints. With high schema coverage, the baseline score of 3 is appropriate, as the schema does the heavy lifting.

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 verb 'Get' and the resource 'detailed information about a specific appliance', making the purpose understandable. It distinguishes from siblings like 'get_appliance_list' by specifying retrieval of a single appliance rather than a list. However, it doesn't explicitly contrast with other 'get_*_info' tools (e.g., 'get_server_info'), so it's not fully specific to sibling 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?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., needing an appliance ID), exclusions (e.g., not for lists), or direct alternatives like 'get_appliance_list' for multiple appliances. Usage is implied by the name but not explicitly stated.

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