Skip to main content
Glama
ahmedselimmansor-ctrl

IBM Cloud MCP Server

vpc_start_instance

Start a stopped IBM Cloud VSI by specifying the instance ID and optionally the region.

Instructions

Start a stopped VSI

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
instance_idYes
regionNo

Implementation Reference

  • Tool registration for vpc_start_instance using MCP server.tool() with Zod schema for inputs and async handler that posts a start action to the VPC API.
    server.tool("vpc_start_instance", "Start a stopped VSI", {
      instance_id: z.string(), region: z.string().optional(),
    }, async (p) => safeTool(async () => { w(); return client.post(vpcUrl(p.region||r, `/instances/${p.instance_id}/actions`),{type:"start"}); }));
  • The handler function that takes input params, asserts write permission, and makes a POST request to the VPC API to start the instance.
    }, async (p) => safeTool(async () => { w(); return client.post(vpcUrl(p.region||r, `/instances/${p.instance_id}/actions`),{type:"start"}); }));
  • Zod schema defining the required 'instance_id' (string) and optional 'region' (string) input parameters.
    server.tool("vpc_start_instance", "Start a stopped VSI", {
      instance_id: z.string(), region: z.string().optional(),
  • Helper function that builds the VPC API URL with region, path, version, and generation parameters.
    export function vpcUrl(region: string, path: string, version: string = "2024-11-19"): string {
      const base = `https://${region}.iaas.cloud.ibm.com/v1${path}`;
      const sep = base.includes("?") ? "&" : "?";
      return `${base}${sep}version=${version}&generation=2`;
    }
  • Helper wrapper that catches errors from the tool handler and returns proper MCP success/error content responses.
    export async function safeTool<T>(fn: () => Promise<T>): Promise<ReturnType<typeof successContent> | ReturnType<typeof errorContent>> {
      try {
        const result = await fn();
        return successContent(result);
      } catch (error) {
        return errorContent(error);
      }
    }
Behavior2/5

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

No annotations are provided, and the description offers no behavioral details such as side effects (e.g., instance transitions to running state), authentication needs, error conditions, or rate limits. For a mutation action, this is a significant gap.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

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

The description is extremely concise at four words, which is efficient for a simple action. However, it sacrifices necessary detail; a slightly longer description could improve clarity without much overhead.

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 output schema, annotations, and detailed parameter descriptions, the description is incomplete. It fails to cover prerequisites, expected outcomes, or edge cases, leaving the agent with significant ambiguity.

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

Parameters2/5

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

With 0% schema description coverage, the description adds no meaning to the parameters 'instance_id' and 'region'. Their purposes are left to inference from parameter names, which may be ambiguous (e.g., region is optional but typically required).

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

Purpose5/5

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

The description 'Start a stopped VSI' clearly states the action (start) and the resource (VSI, a virtual server instance). It effectively distinguishes this tool from siblings like vpc_stop_instance, vpc_reboot_instance, and vpc_create_instance.

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 implies the tool is for stopped instances but does not explicitly state when to use it or when to avoid it. There is no mention of prerequisites (e.g., instance must exist), nor guidance on alternatives like starting via other methods.

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/ahmedselimmansor-ctrl/IBM_cloud_MCP_SERVER'

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