Skip to main content
Glama

ResearchPilot

researchpilot_read_work_artifact

Read-onlyIdempotent

Read one saved working artifact after verifying that both project and artifact belong to the authenticated ResearchPilot owner.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectIdYes
artifactIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already cover readOnly, idempotent, non-destructive, and closed-world behavior. The description adds meaningful context by stating the ownership check on both project and artifact, but it does not say what happens on verification failure (error shape) or what the artifact contains.

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 that carries the action and the key precondition without filler. Slightly dense but well structured.

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?

There is no output schema, so the description would need to explain the return value, and it does not say whether the artifact's content or just its metadata is returned. It also leaves the failure mode of the ownership check unspecified.

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 0%, so the schema only provides UUID patterns for projectId and artifactId. The description adds semantic value by clarifying that both the project and the artifact must belong to the authenticated owner, but it does not explain the relationship between the two IDs or what either represents beyond that.

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 and resource ('Read one saved working artifact') and clarifies it returns a single artifact, implicitly distinguishing it from the sibling list_work_artifacts and save_work_artifact. It does not explicitly name those alternatives, but the singular scope is clear enough for selection.

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?

The description establishes a precondition (ownership verification must pass) but gives no explicit when-to-use vs when-not guidance and names no alternatives. Usage is implied from the 'read one' scope rather than stated.

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