Skip to main content
Glama

get_project

Read-onlyIdempotent

Retrieve a project's key, title, description, attribute values, and case index using its project key. Get complete project details for tracking or review.

Instructions

Returns one project by its key: key, title, description, current attribute values and the index of the project's case.

The keys of the installation's projects are listed by list_projects.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
keyYesProject key, case-insensitive. An unknown key is refused with `project_not_found`

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
keyYes
indexYesIndex of the project's case, titles only, in number order: decisions, findings, artifacts and notes about the project and the tracker's entries about its card. Entry bodies come from `read_project_entries`
titleYes
attributesYesCurrent attribute values, ordered by name ignoring case. Their history is in the project's case: `attribute_created`, `attribute_changed` and `attribute_removed` entries
archived_atYesWhen the project was archived, `null` while it is active. An archived project and its tasks refuse changes with `project_archived`; `restore_project` lifts it
descriptionYesShort "what this is" of the project, up to 320 characters; may be empty. Every task card carries it too

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.5.2

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, covering the safety profile. The description adds value by specifying the return structure (key, title, description, attribute values, case index), but does not go deeper into behavior like pagination, authentication, or error handling beyond what the schema already notes for the key parameter.

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?

Two sentences, front-loaded with the core purpose and return fields. The second sentence provides a useful pointer to list_projects without waste. Every word earns its place.

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?

Given a single required parameter, high schema coverage, an output schema, and annotations covering safety, the description is quite complete. It lists the returned fields and how to obtain the key. Minor omission: it doesn't explicitly state fallback behavior for invalid keys, but that is covered in the schema's parameter description.

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?

The input schema has 100% coverage: the key parameter is described with its meaning, case-insensitivity, and error behavior, plus an example. The description only repeats 'by its key' without adding any new semantic detail, so it does not exceed the schema's documentation. Baseline of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb ('Returns') and resource ('one project by its key'), and enumerates exactly what is returned (key, title, description, attribute values, case index), making it distinct from siblings like list_projects or update_project. It also references list_projects for obtaining keys, further clarifying scope.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implicitly conveys when to use this tool: when you have a project key and want its details. It explicitly points to list_projects for retrieving keys, giving context for the required input. However, it doesn't explicitly state when not to use it (e.g., for bulk retrieval) or mention other alternatives beyond list_projects.

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