Skip to main content
Glama

ws_read

Read-onlyIdempotent

Read a workspace file with line numbers — e.g. projects.txt, job//timeline.txt, job//review/brief.txt, project//assets.txt. At most ~250 lines per call; pass start_line/end_line (1-based, inclusive) for a range. Grep first on long files.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
end_lineNo
start_lineNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and non-destructive behavior. The description adds valuable behavioral details beyond those: line-numbered output, a ~250-line limit per call, and 1-based inclusive start/end semantics. This is meaningful supplementary information.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two dense sentences convey action, output shape, range syntax, line limit, and an efficiency tip without filler. The structure is front-loaded and every phrase earns 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?

For a low-complexity read tool with a rich output schema and safety annotations, the description covers the essential operational concerns: path examples, line cap, range semantics, and grep-first advice. A minor gap is not stating what happens if a range is omitted or if a file exceeds the line limit without a range.

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 0%, so the description carries the burden. It explicitly explains start_line/end_line as a 1-based inclusive range, but the path parameter is only illustrated with examples rather than formally specified. The default behavior when start_line/end_line are omitted is also left implicit.

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 opens with a specific verb-resource pair, 'Read a workspace file with line numbers,' and reinforces it with concrete path examples. This clearly differentiates ws_read from its write/sibling tools like ws_edit, ws_grep, and ws_ls.

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?

The description gives practical context: use it for reading specific workspace files, and 'Grep first on long files' explicitly steers agents toward the grep alternative for lengthy content. It does not enumerate exclusions for all siblings, but the read-only intent and line-range usage are clear enough.

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.