Skip to main content
Glama

Com Api Get

com_api_get
Read-onlyIdempotent

Retrieve read-only data from any Compute Ops Management API path for server inventory, settings, appliances, or reports not covered by other tools; secrets are redacted.

Instructions

Raw read-only GET of any Compute Ops Management API resource, for data the other com_ tools don't cover (server inventory, settings, appliances, reports). Secrets are redacted.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "path": "<path>"
    },
    "name": "com_api_get"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesCOM API path starting with /compute-ops-mgmt/, e.g. /compute-ops-mgmt/v1/servers/{id}/inventory
accountNoCOM account name from list_servers; omit to use the first one.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.6.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered. The description adds genuinely new behavioral context: results are 'raw' passthrough and secrets are redacted, which an agent needs to know before trusting returned fields. Return shape is handled by the output schema, so nothing major is missing.

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?

Two sentences, front-loaded with the verb+resource and followed by the sibling-scoping rule and the redaction caveat. No restatement of the title or boilerplate.

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

Completeness4/5

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

For a raw API passthrough with a fully documented two-parameter schema, complete annotations and an output schema, the description covers purpose, routing and the redaction caveat. It omits error behavior for invalid or unauthorized paths and any rate-limit notes, which would be the remaining useful additions.

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?

Schema description coverage is 100%, and the schema itself explains the /compute-ops-mgmt/ path prefix, the example inventory path, and the optional account default. The description adds no further parameter meaning beyond the generic 'any resource' framing, so the baseline 3 applies.

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?

States a specific verb+resource ('Raw read-only GET of any Compute Ops Management API resource') and immediately scopes it against siblings: 'for data the other com_ tools don't cover', with concrete examples (server inventory, settings, appliances, reports). An agent can tell this is the generic escape hatch rather than a domain-specific com_ getter without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives an explicit routing rule — use this when the other com_ tools don't cover the data — which is exactly the when-to-use guidance a generic passthrough needs. It does not name a specific preferred alternative for covered cases (e.g. 'use com_get_server for server detail'), so the exclusion is by family rather than by named tool.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.