Skip to main content
Glama

Coline

Read a project

read_project
Read-onlyIdempotent

Reads a project: its outcome, people, places, milestones, progress, date range and latest update.

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": {
      "workspace": "<workspace>",
      "projectId": "<projectId>"
    },
    "name": "read_project"
  }
}

Input Schema

NameRequiredDescriptionDefault
projectIdYes
workspaceYesWorkspace slug from workspaces.list, e.g. "acme".

Output Schema

NameRequiredDescriptionDefault
projectYes

Schema Changelog

Changes observed during successful MCP inspections.

No schema history has been recorded yet.

TDQS

B3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered. The description adds useful scope context by listing the kinds of data returned (people, places, milestones, progress, latest update) beyond what the bare annotations convey. It says nothing about permissions, error behavior for a missing project, or size/cost of the response.

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 the verb and resource first, followed by the returned-field list. Every clause carries information and there is no filler, though a semicolon-separated list would read slightly cleaner than the comma chain.

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?

Output schema exists and annotations are rich, so return values and safety behavior are largely covered elsewhere. Still, the description omits the projectId source/format and any failure mode for an unknown project, leaving a small but real gap for a two-required-parameter lookup.

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 only 50%: workspace is documented with a slug example, but projectId has no schema description. The description contributes nothing about either parameter, so it fails to compensate for the undocumented projectId format or where an ID can be obtained.

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 ("Reads a project") and enumerates what the read returns: outcome, people, places, milestones, progress, date range, latest update. That is enough for an agent to distinguish it from mutation siblings like update_project or delete_project, though it doesn't explicitly contrast with read_project_updates.

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?

Provides no explicit when-to-use guidance, no prerequisites, and no statement about when a sibling such as read_project_updates would be preferred. The only implied usage comes from the enumerated contents, which an agent must infer is the full-project fetch.

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