Skip to main content
Glama

workspace_read_file

Read a single file from a source repository via an ephemeral AI workspace on the organisation's staging cluster. Shallow-clones the repo and returns the file contents (bounded). Safe in ask mode: the sandbox job is throwaway and cannot modify existing infrastructure. Requires a configured staging cluster plus either application_id or repository ('owner/name' - an Application-linked repository or one of the cluster's tagged context repositories).

Input Schema

NameRequiredDescriptionDefault
branchNoOptional branch to clone. Defaults to the context tag's branch, the Application's configured branch, or the repository's default branch.
file_pathYesPath to the file, relative to the repository root.
repositoryNoRepository to clone in 'owner/name' form. Must be an Application-linked repository or one of the cluster's tagged context repositories; anything else is rejected with the allowed list.
application_idNoThe Application whose linked repository to clone and read from. Provide this or 'repository'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

No contradiction with annotations, and the description does real work: it explains why readOnlyHint is false (an ephemeral sandbox job is created) while reassuring the agent the job is throwaway and cannot modify existing infrastructure. It discloses shallow-clone and bounded-content behavior. 'Bounded' is left unexplained, a minor gap.

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?

Three sentences, front-loaded with the action and resource before mechanism and prerequisites. Every sentence carries information; the prerequisite sentence is dense but not wasteful.

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 no-output-schema, 4-parameter tool with annotations already covering the safety flags, the description covers mechanism, safety, and prerequisites well. Remaining gaps (what 'bounded' means, return size limits) are minor.

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 100%, so the schema already documents branch, file_path, repository and application_id in detail. The description reinforces the either/or requirement for application_id vs repository and the 'owner/name' constraint, but adds little beyond the schema, making the baseline of 3 appropriate.

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 (Read) and resource (a single file from a source repository) and explains the mechanism (ephemeral AI workspace, shallow clone). It implicitly separates itself from workspace_list_files/workspace_search_code by scoping to a single file, but does not explicitly distinguish itself from github_read_file or code_context.

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 clear conditions for use: 'Requires a configured staging cluster plus either application_id or repository', and notes it is safe in ask mode. It lacks explicit when-to-use guidance versus the sibling file-reading tools (github_read_file, code_context), so it stops short of a routing statement.

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