Skip to main content
Glama

Amplify

Read project file

read_project_file
Read-onlyIdempotent

Read one text file of a project (relative path such as index.html or app.js).

Input Schema

NameRequiredDescriptionDefault
pathYes
projectIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare this as a read-only, idempotent, non-destructive, closed-world operation. The description adds useful scope by saying it reads a single text file via a relative path, but it does not disclose behavior for missing files, encoding, file-size limits, or truncation.

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?

The definition is a single front-loaded sentence with no wasted clauses. The parenthetical examples are directly useful for the path parameter.

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?

For a simple read operation whose safety profile is covered by annotations, the description is mostly adequate. However, it omits projectId semantics and file-handling edge cases, which are more important because there is no output schema or parameter description coverage.

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 must compensate for both parameters. It meaningfully clarifies that path is relative and gives examples such as index.html and app.js, but projectId is left only implicitly defined as "a project" with no guidance on where to obtain it or its expected format.

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 gives a specific verb and resource: read one text file of a project. The parenthetical example clarifies that it expects a relative file path rather than project metadata. It does not explicitly distinguish itself from siblings, but the file-oriented scope is clear.

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?

Usage is implied by "Read one text file of a project" and the relative-path examples, but the description does not state when to use this instead of project-level tools such as get_project. It also does not mention exclusions, such as binary files or directories.

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.