Skip to main content
Glama

Read an operation's answer

api_read
Read-onlyIdempotent

Runs one read (GET) operation of The Deployer's app as the person: domains, scaling, schedules, databases and other cloud services, app access, environments, blueprints, servers and more. Changes nothing. Secrets are never returned. Documented at https://portal.thedploy.com/docs.

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": "api_read"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesThe operation's path with ids filled in, e.g. /projects/12/scaling
queryNoQuery parameters
workspaceNoA teammate's workspace id. Default: your own.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, but the description adds genuinely new behavior: it acts 'as the person' (auth context), 'Secrets are never returned' (data-exposure guarantee), and it is open-world with an external docs reference. Return shape and error behavior for bad paths remain undisclosed.

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?

Three short sentences, front-loaded with the operation type and safety statement before the docs link. The long domain enumeration is informative about scope but is the one part that could be trimmed.

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?

With no output schema, the description should carry more of the response burden; it only guarantees secrets are excluded, not what an answer looks like or how failures on an unknown path surface. Adequate for invocation, thin for interpretation.

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%, so path/query/workspace are already documented in the schema; the description adds no syntax, format, or default behavior beyond what those fields state. The phrase 'one operation' loosely ties to the single required path, but that is marginal added meaning.

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?

States a specific verb+resource: 'Runs one read (GET) operation of The Deployer's app as the person,' then enumerates the resource families covered (domains, scaling, schedules, databases, environments, blueprints, servers). An agent can tell this is the read path of the API surface versus api/api_catalog/api_schema, though no sibling is named explicitly.

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

Usage Guidelines3/5

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

The read-only framing ('Runs one read (GET) operation', 'Changes nothing') implies when to reach for it, but there is no explicit guidance on when to use api_schema or api_catalog to discover the path first, or when the non-read 'api' sibling is appropriate. The docs link is a pointer, not a rule.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.