Skip to main content
Glama

project_read

Read-only

Read the current circuit revision and source hash for a Proteus project so you can verify design state before editing or comparing changes.

Instructions

Read circuit revision and source hash.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "project": "<project>"
    },
    "name": "project_read"
  }
}

Input Schema

NameRequiredDescriptionDefault
projectYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds the substantive fact that the call returns a revision and a source hash, but says nothing about behavior when the project is unknown, not open, or unchanged. With annotations carrying safety, this is adequate but thin.

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 front-loaded sentence with zero filler and the key output content stated first. It is arguably too short for its responsibilities, but no wording is wasted.

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?

The tool is simple, but with no output schema the description is the only source for what 'revision' and 'source hash' mean and how the 'project' identifier is formed, and it supplies neither. It also omits preconditions (project opened/validated) that sibling tools like project_open and project_validate imply are stateful.

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% for the single required 'project' parameter, and the description does not compensate: it never says whether 'project' is a name, path, or handle. The only documented semantics come from the parameter key itself. For a one-param tool this is the main semantic gap.

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 specific returned resources (circuit revision, source hash), which distinguishes it from mutation siblings like circuit_edit or project_save. It stops short of differentiating from other read-style siblings such as live_read or project_validate, so it is clear but not fully disambiguating.

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?

There is no guidance on when to call this versus alternatives: nothing says whether the project must first be opened via project_open, or why an agent would want the revision/hash (e.g., change detection, staleness checks). The agent must infer the use case entirely.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.