Skip to main content
Glama

Read project file

projects_files_read
Read-onlyIdempotent

Read a text file, including an uncommitted change when one exists.

Input Schema

NameRequiredDescriptionDefault
pathYesPath of the text file to read.
project_idYesUUID of a Bunstation project owned by the authenticated user.

Output Schema

NameRequiredDescriptionDefault
pathYes
contentYes
truncatedYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint/idempotentHint/non-destructive, so the safety profile is covered. The description adds genuinely useful behavior beyond them: the read reflects uncommitted changes, meaning the result may diverge from committed state — a fact no annotation or schema conveys.

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?

A single front-loaded sentence with zero filler; the most decision-relevant nuance (uncommitted changes) is placed where it will be read first.

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?

Output schema exists, so return-value explanation is unnecessary, and annotations carry the safety profile. Only minor gaps remain, such as path resolution semantics and what happens for a nonexistent path.

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 both project_id (owned-project UUID) and path are fully documented in structured fields. The description adds nothing about path resolution relative to the project root, so baseline 3 applies.

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?

States a specific verb (read) and resource (a project text file), and adds the nontrivial detail that it returns uncommitted working-tree content when present. It does not name the near-sibling projects_media_read, so the text-vs-binary distinction must be inferred from the word 'text'.

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 explicit when-to-use guidance, no prerequisites, and no alternatives named. An agent must infer that media_read covers binary assets and files_list covers directory enumeration purely from the one word 'text'.

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