Skip to main content
Glama

get_integration_sample_shape

Read-only

Ask an integration's URL about one user and get the shape of its answer: the keys, and the kind of each value (text, number, yes/no, empty) in place of the value. A list shows its first item's shape. Use the keys as JSON Pointers in set_side_panel (/plan, /orders/0/id). You are never shown the values. Owner only.

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": {
      "integration_id": "<integration_id>",
      "user_id": "<user_id>"
    },
    "name": "get_integration_sample_shape"
  }
}

Input Schema

NameRequiredDescriptionDefault
user_idYesThe id the workspace's own site uses for one of its users, to ask the URL about. Ask the person for one.
integration_idYesThe integration's id (a uuid), from list_integrations.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior5/5

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

Beyond the readOnly/openWorld annotations it discloses the key non-obvious traits: values are never returned (only types), lists are summarized by their first item's shape, and access is restricted to the owner. These are exactly the things an agent would otherwise get wrong.

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?

Front-loaded with the core action, then tight supporting sentences covering list handling, downstream use, and access scope, all with zero filler. The telegraphic phrasing ('you get the shape... in place of the value') is slightly dense but still readable.

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?

There is no output schema, and the description fully compensates by explaining the return value's structure (keys plus value kinds: text, number, yes/no, empty) and list handling. Combined with the annotation-covered safety profile, an agent has everything needed to call and interpret it.

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 both parameters are documented in-schema (user_id is the site's own user id, integration_id from list_integrations). The description restates the pairing ('an integration's URL about one user') but adds no syntax or format detail beyond the schema, so 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 and resource: 'Ask an integration's URL about one user and get the shape of its answer', then pins down exactly what comes back ('the keys, and the kind of each value'). This clearly separates it from test_integration and test_integration_address, which probe connectivity rather than returning a schema shape.

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 concrete downstream usage ('Use the keys as JSON Pointers in set_side_panel') with worked examples (/plan, /orders/0/id), so the agent knows why and how to chain it. It stops short of naming when to prefer test_integration/test_integration_address instead, leaving the boundary to inference.

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.

Resources