Skip to main content
Glama

Get a Resource

get_resource
Read-onlyIdempotent

Fetch one Control Plane resource by kind + name (no name for kind="org"). Returns a summary plus the full JSON. The single read-one tool for every resource kind. Secrets return metadata only — the API never includes their data. Read the target here before update_* or delete_resource; job tools such as rollback_workload and diagnose_workload read it themselves.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
gvcNoGVC slug — REQUIRED only for GVC-scoped kinds (workload, identity, volumeset); ignored otherwise.
orgNoOrganization slug.
kindYesResource kind to fetch.
nameNoResource name. Required for every kind except `org` (which is singular). Most kinds use lowercase kebab-case names; exceptions: domain = the full hostname ("app.example.com"), image = NAME or NAME:TAG ("my-app:v1.2").

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
okYes
dataNoThe full result. Read this, not only the summary.
detailsNo
summaryYes
nextStepsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed20 schema fields changed
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • removedInput schema / additionalProperties
      Removed value: -false
    • removedInput schema / properties / gvc / maxLength
      Removed value: -63
    • removedInput schema / properties / gvc / minLength
      Removed value: -1
    • removedInput schema / properties / gvc / pattern
      Removed value: -"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$"
    • changedInput schema / properties / kind / description
      Previous value: -"Resource kind to fetch. One of: org, workload, identity, volumeset, gvc, secret, policy, group, domain, cloudaccount, agent, ipset, mk8s, serviceaccount, auditctx, image, location, user."New value: +"Resource kind to fetch."
    • removedInput schema / properties / name / maxLength
      Removed value: -257
    • removedInput schema / properties / name / minLength
      Removed value: -1
    • changedInput schema / properties / org / description
      Previous value: -"Organization slug (lowercase kebab-case). NEVER guess — if the user has not named one, ask. On org-not-found, stop and ask; do not retry variants."New value: +"Organization slug."
    • removedInput schema / properties / org / maxLength
      Removed value: -63
    • removedInput schema / properties / org / minLength
      Removed value: -1
    • removedInput schema / properties / org / pattern
      Removed value: -"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$"
    • changedInput schema / required
      Previous value: -[
      -  "kind",
      -  "org"
      -]New value: +[
      +  "kind"
      +]
    • removedOutput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • removedOutput schema / additionalProperties
      Removed value: -false
    • changedOutput schema / properties / data / description
      Previous value: -"The full machine-readable result — list rows, the resource object, query results. Read THIS, not just the summary."New value: +"The full result. Read this, not only the summary."
    • addedOutput schema / properties / details
      Added value: +{
      +  "type": "string"
      +}
    • removedOutput schema / properties / nextSteps / description
      Removed value: -"Recommended follow-up actions for this task, in order."
    • removedOutput schema / properties / ok / description
      Removed value: -"Whether the call succeeded."
    • removedOutput schema / properties / summary / description
      Removed value: -"One-line summary of the result."
  2. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint/idempotentHint/destructiveHint=false, so the safety profile is covered. The description adds genuinely non-obvious behavior: secrets return metadata only because the API never includes their data, and the return is a summary plus full JSON. It does not mention auth or rate-limit characteristics.

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?

Four tight sentences, front-loaded with identity and scope, then caveats, then workflow routing. No filler, and every sentence carries actionable information.

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

Completeness5/5

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

Return values are covered by the output schema, and the description still flags the secrets-metadata exception, which the schema cannot express. Combined with the sibling routing and prerequisite note, an agent has everything needed to call this correctly.

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%, with kind enum and gvc/name scoping rules already documented in the schema, so the baseline of 3 applies. The description restates the org-has-no-name case and the GVC-scoped requirement rather than adding new syntax or edge cases beyond the schema.

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 ('Fetch one Control Plane resource by kind + name') and explicitly positions itself as 'The single read-one tool for every resource kind', which distinguishes it from list_resources and search_control_plane in the sibling list.

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 clear sequencing guidance ('Read the target here before update_* or delete_resource') and notes that job tools like rollback_workload and diagnose_workload read it themselves, so the agent knows when not to call it. It stops short of naming list_resources/search_control_plane as the alternatives for enumeration or fuzzy lookup.

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.