Skip to main content
Glama
ahmedselimmansor-ctrl

IBM Cloud MCP Server

resource_update_instance

Update the name, plan, or parameters of an existing IBM Cloud resource instance.

Instructions

Update a resource instance (name, plan, etc.)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
instance_idYes
nameNo
resource_plan_idNo
parametersNoJSON string of parameters

Implementation Reference

  • Registration of the 'resource_update_instance' tool with its schema and handler via server.tool() call. Defines the tool name, description, input schema (instance_id required; name, resource_plan_id, parameters optional), and the async handler that validates write permissions and sends a PATCH request.
    server.tool("resource_update_instance", "Update a resource instance (name, plan, etc.)", {
      instance_id: z.string(), name: z.string().optional(), resource_plan_id: z.string().optional(),
      parameters: z.string().optional().describe("JSON string of parameters"),
    }, async (p) => safeTool(async () => { w();
      const body: Record<string,unknown> = {};
      if(p.name) body.name=p.name;
      if(p.resource_plan_id) body.resource_plan_id=p.resource_plan_id;
      if(p.parameters) body.parameters=JSON.parse(p.parameters);
      return client.patch(`${base}/resource_instances/${encodeURIComponent(p.instance_id)}`, body);
    }));
  • Input schema for the tool: instance_id (z.string(), required), name (z.string().optional()), resource_plan_id (z.string().optional()), and parameters (z.string().optional() with description 'JSON string of parameters').
    server.tool("resource_update_instance", "Update a resource instance (name, plan, etc.)", {
      instance_id: z.string(), name: z.string().optional(), resource_plan_id: z.string().optional(),
      parameters: z.string().optional().describe("JSON string of parameters"),
  • Handler function that builds a body object with only the provided optional fields (name, resource_plan_id, parameters), parses the parameters JSON string if present, and sends a PATCH request to the resource instances API endpoint. Wraps execution in safeTool() for error handling and asserts write permission via w().
    }, async (p) => safeTool(async () => { w();
      const body: Record<string,unknown> = {};
      if(p.name) body.name=p.name;
      if(p.resource_plan_id) body.resource_plan_id=p.resource_plan_id;
      if(p.parameters) body.parameters=JSON.parse(p.parameters);
      return client.patch(`${base}/resource_instances/${encodeURIComponent(p.instance_id)}`, body);
    }));
  • The registerResourceManagementTools function that is exported and called from server.ts (line 77) to register all resource management tools including resource_update_instance.
    export function registerResourceManagementTools(server: McpServer, client: IBMCloudAPIClient, config: ServerConfig) {
  • Registration call that wires the resource management tools (including resource_update_instance) into the MCP server.
    registerResourceManagementTools(server, client, config);
Behavior2/5

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

With no annotations, the description carries full burden for behavioral disclosure. It implies mutation but lacks details on side effects, permissions, or idempotency, making it insufficient.

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?

Single sentence, front-loaded with action and resource, no redundant words, very concise.

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 4 parameters, no output schema, and no annotations, the description is too brief; it lacks explanation of required fields, return behavior, and fuller enumeration of updatable fields beyond 'name, plan, etc.'

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 description mentions 'name, plan, etc.' which maps partially to schema parameters (name, resource_plan_id) but does not explain the required instance_id or the parameters JSON field. Schema coverage is only 25%, so description should compensate more.

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 clearly states the action 'Update' and the resource 'resource instance', with examples 'name, plan, etc.', which distinguishes it from create/delete/list siblings.

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?

No guidance on when to use or not use this tool, no comparison to alternatives, and no prerequisites mentioned.

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