Skip to main content
Glama

workbench_inspect_source

Read-only

List, search, or read source files with line numbers using a caller-selected root; no code is executed, and partial coverage is clearly reported.

Instructions

Inspect the caller-selected source_root: list files, literal search or a line-numbered read. No code is executed. Symlinks and generated directories are excluded from discovery. Partial coverage is explicit.

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": {
      "case_id": "<case_id>",
      "action": "<action>"
    },
    "name": "workbench_inspect_source"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathNo.
limitNo
queryNoTODO
actionYes
case_idYes
start_lineNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

B3.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered; the description still adds real value by stating no code is executed, that symlinks and generated directories are skipped during discovery, and that partial coverage is surfaced explicitly rather than silently truncated. The only gap is that it does not describe pagination or how the 'partial coverage' signal is presented.

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?

Four short sentences, front-loaded with the core operation and followed by constraints, with no filler. 'Partial coverage is explicit' is slightly cryptic in isolation but is the only sentence that costs the reader a second pass.

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

Completeness3/5

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

With no output schema and zero parameter documentation, the description should do more: it never explains the required case_id, the meaning of limit or query defaults, or what a result looks like beyond 'line-numbered'. It is adequate to select the tool but thin for invoking it correctly across all three actions.

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

Parameters2/5

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

Schema description coverage is 0% across six parameters, so the description carries the full burden and only partially meets it: it implies the action modes and a line-numbered read (hinting at start_line), and gestures at path via 'caller-selected source_root'. The query, limit, and case_id parameters receive no explanation at all, leaving half the surface undocumented in both schema and prose.

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?

The description names a specific verb (inspect) and resource (the caller-selected source_root) and enumerates the three modes — list files, literal search, line-numbered read — which map cleanly onto the action enum. It does not explicitly contrast itself with siblings like workbench_read_record or workbench_analyze, so an agent must infer the boundary, but the operation itself is unambiguous.

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?

The three modes imply when each action applies, and 'No code is executed' plus the exclusion of symlinks/generated directories sets expectations about scope. However, there is no explicit guidance on when to choose this tool over workbench_read_record or workbench_analyze, and no stated prerequisites for obtaining a case_id.

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