Skip to main content
Glama
hidenorigoto

Sakura Cloud MCP Server

by hidenorigoto

get_interface_list

Retrieve network interface details to manage connectivity and configuration within Sakura Cloud infrastructure.

Instructions

Get list of network interfaces

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The main handler function for the 'get_interface_list' tool. It validates credentials, fetches the list of network interfaces from the Sakura Cloud API using the helper fetchFromSakuraCloud('/interface'), stringifies the result as JSON, and returns it in the MCP tool response format.
    } else if (request.params.name === 'get_interface_list') {
      try {
        validateCredentials();
        
        const interfaceList = await fetchFromSakuraCloud(`/interface`);
        
        return {
          content: [
            {
              type: 'text',
              text: JSON.stringify(interfaceList, null, 2)
            }
          ]
        };
      } catch (error) {
        console.error('Error calling tool:', error);
        throw error;
      }
    } else if (request.params.name === 'get_interface_info') {
  • src/server.ts:954-962 (registration)
    Registration of the 'get_interface_list' tool in the ListToolsRequestSchema handler, including its name, description, and empty input schema (no parameters required).
    {
      name: 'get_interface_list',
      description: 'Get list of network interfaces',
      inputSchema: {
        type: 'object',
        properties: {
        },
      }
    },
  • Input schema for the 'get_interface_list' tool, which is an empty object (no required parameters).
      inputSchema: {
        type: 'object',
        properties: {
        },
      }
    },
  • Core helper function used by the tool to make authenticated HTTPS GET requests to the Sakura Cloud API endpoint for interfaces (`/interface`). Handles authentication, JSON parsing, and error handling.
    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 tool handler to validate that required Sakura Cloud API credentials are set as 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. While 'Get list' implies a read-only operation, it doesn't specify whether this requires authentication, what format the list returns (e.g., names only vs. full objects), if there are rate limits, or if the list is filtered/paginated. For a tool with zero annotation coverage, this leaves significant behavioral gaps.

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 ('Get list of network interfaces') that directly states the purpose without any unnecessary words. It's front-loaded with the core action and resource, making it immediately scannable and easy to understand.

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

Completeness3/5

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

Given the tool's simplicity (0 parameters, no output schema, no annotations), the description is minimally adequate but lacks context about the return format or behavioral constraints. It doesn't explain what 'list' entails (e.g., array of names vs. objects), which could be important for an agent to process the output correctly. However, for a basic list tool, it meets the minimum threshold.

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

Parameters4/5

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

The tool has 0 parameters, and schema description coverage is 100% (though empty). The description doesn't need to explain any parameters, which is appropriate. It could theoretically mention that no parameters are required, but this is adequately covered by the structured schema, so a baseline score of 4 is warranted for zero-parameter tools.

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 'Get list of network interfaces' clearly states the action (get) and resource (network interfaces), making the purpose immediately understandable. However, it doesn't differentiate itself from sibling tools like 'get_interface_info' which presumably provides detailed information about a specific interface, leaving room for potential confusion about when to use each.

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. With sibling tools like 'get_interface_info' (for detailed info on a specific interface) and various other list tools (e.g., 'get_server_list', 'get_zone_list'), there's no indication of when this list retrieval is appropriate versus when other list tools or the info variant should be used.

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