Skip to main content
Glama

Get Interface

get_interface
Read-only

Retrieve a single published interface FRAME by name from a component to support reference-by-name templates; an unpublished name fails with an error.

Instructions

Read back a single published interface FRAME by name from a component (issue #139). The reference-by-name primitive feature templates ride on: an unpublished name fails loudly. Returns {handle, name, frame}.

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": {
      "handle": "<handle>",
      "name": "<name>"
    },
    "name": "get_interface"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYes
handleYes
workspaceNoRun this call in this named workspace

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.5.7
    • addedInput schema / properties / workspace
      Added value: +{
      +  "default": "",
      +  "description": "Run this call in this named workspace",
      +  "title": "Workspace",
      +  "type": "string"
      +}
  2. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered; the description adds genuinely new behavior: 'an unpublished name fails loudly' tells the agent to expect an error rather than a null, and 'Returns {handle, name, frame}' discloses the response shape absent an output schema. It could still say more about lookup scope across workspaces.

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 verb and resource, then the failure behavior, then the return shape – a sensible order. The '(issue #139)' citation and the 'primitive feature templates ride on' clause consume space without helping the calling agent.

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?

For a three-parameter read-only getter with no output schema, the description covers the essentials: what it fetches, the keying by name, the error on unpublished names, and the returned fields. An agent has enough to invoke it correctly and interpret the result.

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 coverage is 33% – only 'workspace' is documented in the schema, leaving handle and name bare. The description partially compensates by clarifying that name means an interface name ('by name') and that the lookup is scoped 'from a component', implying handle is a component handle. It never states handle format or where a handle comes from.

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 and resource: 'Read back a single published interface FRAME by name from a component.' An agent can distinguish this from publish_interface by the read/published-name framing. The '(issue #139)' reference and 'primitive feature templates ride on' phrasing add noise rather than precision, and it doesn't contrast with the nearest read siblings like get_object.

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?

Usage is only implied: you read an interface back by name after it has been published. There is no explicit statement of when to prefer this over get_object or list_face_roles, though 'The reference-by-name primitive feature templates ride on' gestures at the downstream use case. The precondition that unpublished names fail is about failure mode, not tool selection.

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

Deploy Server

Other Tools