Skip to main content
Glama

Read one shim

workbench_shim_get
Read-only

One shim in full: the question, where its inputs come from, every answer with its description and examples, what the shim still needs before it can build, and the newest build's report — held-out accuracy, recall per answer, which answers get mistaken for which, and the compiler's notes. Read it before writing examples: match the setting and the existing examples' register, and put new examples where recall is low or the compiler says an answer is thin.

Input Schema

NameRequiredDescriptionDefault
shimIdYesShim id, from workbench_shim_list.
workspaceNoWorkspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

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?

Annotations already declare readOnlyHint=true and destructiveHint=false, so safety is covered, yet the description goes well beyond them by enumerating the returned payload — question, input sources, per-answer descriptions and examples, build-readiness gaps, and build metrics like held-out accuracy, per-answer recall, confusion pairs, and compiler notes. With no output schema, this return-format disclosure is genuinely valuable.

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 'One shim in full' followed by an em-dash inventory and then actionable guidance. It is dense and long, but nearly every clause conveys concrete content or instruction rather than filler, so it earns its place despite the length.

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 read-only retrieval tool with no output schema, the description fully compensates by describing the return payload in detail and even explaining how to act on it (write examples toward low-recall answers). Nothing an agent needs to call this correctly is missing.

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 100%: shimId is documented as coming from workbench_shim_list, and workspace documents the personal-token/workspace-key rules. The description adds no additional parameter semantics, so the baseline 3 is appropriate — the schema carries the full burden.

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?

The description states exactly what this tool returns: the full contents of one shim — the question, input provenance, every answer with examples, build readiness, and the latest build report. This is clearly distinguishable from siblings like workbench_shim_list (enumeration), workbench_shim_create, and workbench_shim_add_answer/add_examples, so an agent can route correctly without inspecting schemas.

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?

It gives concrete usage context: 'Read it before writing examples', match the existing examples' register, and place new examples where recall is low or the compiler flags thin answers. That is strong when-to-use guidance tied to a workflow, but it names no explicit exclusion or alternative tool (e.g. don't call if you only need the id list).

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