Skip to main content
Glama

websex_workspace_read

Read a UTF-8 text file from a WebSex engagement workspace by providing an engagement ID and file path to retrieve stored evidence or notes.

Instructions

Read a UTF-8 text file from the WebSex engagement workspace.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
engagement_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.7/5.0
Behavior2/5

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

With no annotations, the description carries the full behavioral burden. It discloses that the tool reads UTF-8 text (implying binary files are unsupported), but omits error handling, permission requirements, path traversal constraints, and whether the operation is strictly read-only.

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?

A single sentence with no fluff, front-loading the core action. It is appropriately sized for a simple read operation, though it could be slightly more structured to include parameter hints.

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

Completeness2/5

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

Given zero annotation coverage, zero schema description coverage, and two required parameters, the description is incomplete. While an output schema exists (so return values need no explanation), the description leaves key input semantics and operational boundaries unspecified.

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%, so the description should explain the two required parameters. It only vaguely implies an engagement workspace and a file path, but does not clarify what engagement_id represents or how the path should be formatted (relative/absolute).

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 states a specific verb ('Read') and resource ('UTF-8 text file') scoped to the engagement workspace, making the core action clear. It does not explicitly differentiate from siblings like workspace_list or workspace_write, but the verb naturally distinguishes it from write/delete/list operations.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No when-to-use or when-not-to-use guidance is provided; the description only states what the tool does. An agent must infer that it is used to retrieve file contents rather than list or modify workspace files.

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