Skip to main content
Glama

inspect_interface

Read-onlyIdempotent

Opens one discovered target and returns a numbered menu of actions with inputs and read/write/destructive effects; use follow IDs to open another page. Read-only.

Instructions

Open ONE target from discover_capabilities and return a numbered menu of actions with inputs and effect (read/write/destructive). Use follow with a nav id to open another page. Read-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": {
      "target": "<target>"
    },
    "name": "inspect_interface"
  }
}

Input Schema

NameRequiredDescriptionDefault
followNo
targetYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

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, and 'Read-only' merely restates them. The value added is behavioral detail beyond annotations: one target at a time, the returned menu labels each action's effect as read/write/destructive, and `follow` continues navigation. It stops short of describing what happens on an invalid target or nav id.

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 core action and return shape, with no filler. The trailing 'Read-only.' duplicates the annotation and is the one sentence that does not fully earn its place.

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?

With no output schema, the description usefully characterizes the return value (numbered menu with inputs and effect labels) and the paging mechanism. For a 2-parameter read tool this is close to complete; only error/edge behavior and id formats are absent.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must carry both parameters, and it does: `target` is a single item sourced from discover_capabilities, and `follow` takes a nav id to open another page. What is missing is any hint about the string format of a target or nav id (prefix, id shape).

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 ('Open ONE target ... return a numbered menu of actions with inputs and effect') and anchors the resource to a sibling ('target from discover_capabilities'), so an agent can tell this is the browse/inspect step rather than discovery or execution. It also names the shape of what comes back (a numbered menu with effects), which is more than a restatement of the name.

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 a clear workflow position: the target must come from discover_capabilities, and `follow` with a nav id is how you page deeper. It does not explicitly say when NOT to use it (e.g., once a menu is chosen, hand off to propose_workflow/execute_workflow), so the routing to siblings is implied rather than stated.

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