Skip to main content
Glama

Get project

get_project
Read-onlyIdempotent

Retrieve a project's details by its key: title, description, attributes, decisions, and case index. Use to inspect a specific project.

Instructions

Returns one project by its key: key, title, description, current attribute values, the project decisions in force 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
decisionsYesProject decisions in force, in number order: `decision` entries of the project's case that no later decision names in `supersedes`. Bodies come from `read_project_entries`; the tasks citing a decision, from `search_tasks` with `decision`
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. Changed18 schema fields changedv0.10.1
    • changedOutput schema / $defs / AnswerFactsView / description
      Previous value: -"Answer: the question of the same task it answers."New value: +"Answer: the question of the same task it closes, how, and what replaced it."
    • addedOutput schema / $defs / AnswerFactsView / properties / outcome
      Added value: +{
      +  "anyOf": [
      +    {
      +      "description": "How a question was closed by an answer",
      +      "enum": [
      +        "answered",
      +        "withdrawn",
      +        "replaced"
      +      ],
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • addedOutput schema / $defs / AnswerFactsView / properties / replaced_by
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "title": "Replaced By"
      +}
    • changedOutput schema / $defs / AnswerFactsView / required
      Previous value: -[
      -  "type",
      -  "question_no"
      -]New value: +[
      +  "type",
      +  "question_no",
      +  "outcome",
      +  "replaced_by"
      +]
    • addedOutput schema / $defs / DecisionInForceView
      Added value: +{
      +  "description": "Project decision in force: its address and the decision in one line.",
      +  "properties": {
      +    "ref": {
      +      "description": "Address of the `decision` entry in the project's case",
      +      "examples": [
      +        "TRK#15"
      +      ],
      +      "title": "Ref",
      +      "type": "string"
      +    },
      +    "title": {
      +      "title": "Title",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "ref",
      +    "title"
      +  ],
      +  "title": "DecisionInForceView",
      +  "type": "object"
      +}
    • addedOutput schema / $defs / FactsView / discriminator / mapping / acceptance
      Added value: +"#/$defs/NoFactsView"
    • addedOutput schema / $defs / FactsView / discriminator / mapping / warning
      Added value: +"#/$defs/WarningFactsView"
    • changedOutput schema / $defs / FactsView / oneOf
      Previous value: -[
      -  {
      -    "$ref": "#/$defs/NoFactsView"
      -  },
      -  {
      -    "$ref": "#/$defs/StatusChangedFactsView"
      -  },
      -  {
      -    "$ref": "#/$defs/SectionChangedFactsView"
      -  },
      -  {
      -    "$ref": "#/$defs/FieldChangedFactsView"
      -  },
      -  {
      -    "$ref": "#/$defs/AssigneeChangedFactsView"
      -  },
      -  {
      -    "$ref": "#/$defs/LinkFactsView"
      -  },
      -  {
      -    "$ref": "#/$defs/QuestionFactsView"
      -  },
      -  {
      -    "$ref": "#/$defs/AnswerFactsView"
      -  },
      -  {
      -    "$ref": "#/$defs/VerdictFactsView"
      -  },
      -  {
      -    "$ref": "#/$defs/ResolutionFactsView"
      -  },
      -  {
      -    "$ref": "#/$defs/AttributeFactsView"
      -  },
      -  {
      -    "$ref": "#/$defs/MovedFactsView"
      -  }
      -]New value: +[
      +  {
      +    "$ref": "#/$defs/NoFactsView"
      +  },
      +  {
      +    "$ref": "#/$defs/StatusChangedFactsView"
      +  },
      +  {
      +    "$ref": "#/$defs/SectionChangedFactsView"
      +  },
      +  {
      +    "$ref": "#/$defs/FieldChangedFactsView"
      +  },
      +  {
      +    "$ref": "#/$defs/AssigneeChangedFactsView"
      +  },
      +  {
      +    "$ref": "#/$defs/LinkFactsView"
      +  },
      +  {
      +    "$ref": "#/$defs/QuestionFactsView"
      +  },
      +  {
      +    "$ref": "#/$defs/AnswerFactsView"
      +  },
      +  {
      +    "$ref": "#/$defs/VerdictFactsView"
      +  },
      +  {
      +    "$ref": "#/$defs/ResolutionFactsView"
      +  },
      +  {
      +    "$ref": "#/$defs/AttributeFactsView"
      +  },
      +  {
      +    "$ref": "#/$defs/MovedFactsView"
      +  },
      +  {
      +    "$ref": "#/$defs/WarningFactsView"
      +  }
      +]
    • changedOutput schema / $defs / FieldChangedFactsView / properties / field / anyOf
      Previous value: -[
      -  {
      -    "description": "Task field",
      -    "enum": [
      -      "title",
      -      "description",
      -      "goal",
      -      "context",
      -      "constraints",
      -      "output",
      -      "checks",
      -      "status",
      -      "assignee",
      -      "priority"
      -    ],
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "description": "Task field",
      +    "enum": [
      +      "title",
      +      "description",
      +      "goal",
      +      "context",
      +      "constraints",
      +      "output",
      +      "checks",
      +      "status",
      +      "assignee",
      +      "priority",
      +      "decisions"
      +    ],
      +    "type": "string"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedOutput schema / $defs / HeadingView / properties / type / enum
      Previous value: -[
      -  "summary",
      -  "decision",
      -  "attempt",
      -  "finding",
      -  "artifact",
      -  "question",
      -  "answer",
      -  "verdict",
      -  "remark",
      -  "resolution",
      -  "note",
      -  "created",
      -  "status_changed",
      -  "section_changed",
      -  "field_changed",
      -  "assignee_changed",
      -  "link_added",
      -  "link_removed",
      -  "moved",
      -  "attribute_created",
      -  "attribute_changed",
      -  "attribute_removed",
      -  "archived",
      -  "restored"
      -]New value: +[
      +  "summary",
      +  "decision",
      +  "attempt",
      +  "finding",
      +  "artifact",
      +  "question",
      +  "answer",
      +  "verdict",
      +  "remark",
      +  "resolution",
      +  "acceptance",
      +  "note",
      +  "created",
      +  "status_changed",
      +  "section_changed",
      +  "field_changed",
      +  "assignee_changed",
      +  "link_added",
      +  "link_removed",
      +  "moved",
      +  "warning",
      +  "attribute_created",
      +  "attribute_changed",
      +  "attribute_removed",
      +  "archived",
      +  "restored"
      +]
    • changedOutput schema / $defs / NoFactsView / properties / type / enum
      Previous value: -[
      -  "summary",
      -  "decision",
      -  "attempt",
      -  "finding",
      -  "artifact",
      -  "remark",
      -  "note",
      -  "created",
      -  "archived",
      -  "restored"
      -]New value: +[
      +  "summary",
      +  "decision",
      +  "attempt",
      +  "finding",
      +  "artifact",
      +  "remark",
      +  "acceptance",
      +  "note",
      +  "created",
      +  "archived",
      +  "restored"
      +]
    • changedOutput schema / $defs / SectionChangedFactsView / properties / field / anyOf
      Previous value: -[
      -  {
      -    "description": "Task field",
      -    "enum": [
      -      "title",
      -      "description",
      -      "goal",
      -      "context",
      -      "constraints",
      -      "output",
      -      "checks",
      -      "status",
      -      "assignee",
      -      "priority"
      -    ],
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "description": "Task field",
      +    "enum": [
      +      "title",
      +      "description",
      +      "goal",
      +      "context",
      +      "constraints",
      +      "output",
      +      "checks",
      +      "status",
      +      "assignee",
      +      "priority",
      +      "decisions"
      +    ],
      +    "type": "string"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedOutput schema / $defs / StatusChangedFactsView / properties / from_status / anyOf
      Previous value: -[
      -  {
      -    "description": "Task status",
      -    "enum": [
      -      "backlog",
      -      "open",
      -      "in_progress",
      -      "waiting",
      -      "done",
      -      "cancelled"
      -    ],
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "description": "Task status",
      +    "enum": [
      +      "backlog",
      +      "open",
      +      "in_progress",
      +      "done",
      +      "cancelled"
      +    ],
      +    "type": "string"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedOutput schema / $defs / StatusChangedFactsView / properties / to_status / anyOf
      Previous value: -[
      -  {
      -    "description": "Task status",
      -    "enum": [
      -      "backlog",
      -      "open",
      -      "in_progress",
      -      "waiting",
      -      "done",
      -      "cancelled"
      -    ],
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "description": "Task status",
      +    "enum": [
      +      "backlog",
      +      "open",
      +      "in_progress",
      +      "done",
      +      "cancelled"
      +    ],
      +    "type": "string"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedOutput schema / $defs / VerdictFactsView / properties / outcome / anyOf
      Previous value: -[
      -  {
      -    "description": "Outcome of a review check",
      -    "enum": [
      -      "passed",
      -      "failed"
      -    ],
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "description": "Outcome of a review check",
      +    "enum": [
      +      "passed",
      +      "partial",
      +      "unverifiable",
      +      "failed"
      +    ],
      +    "type": "string"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • addedOutput schema / $defs / WarningFactsView
      Added value: +{
      +  "description": "Warning: numbers of the checks closed `partial` and `unverifiable`.",
      +  "properties": {
      +    "partial": {
      +      "anyOf": [
      +        {
      +          "items": {
      +            "type": "integer"
      +          },
      +          "type": "array"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "title": "Partial"
      +    },
      +    "type": {
      +      "const": "warning",
      +      "title": "Type",
      +      "type": "string"
      +    },
      +    "unverifiable": {
      +      "anyOf": [
      +        {
      +          "items": {
      +            "type": "integer"
      +          },
      +          "type": "array"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "title": "Unverifiable"
      +    }
      +  },
      +  "required": [
      +    "type",
      +    "partial",
      +    "unverifiable"
      +  ],
      +  "title": "WarningFactsView",
      +  "type": "object"
      +}
    • addedOutput schema / properties / decisions
      Added value: +{
      +  "description": "Project decisions in force, in number order: `decision` entries of the project's case that no later decision names in `supersedes`. Bodies come from `read_project_entries`; the tasks citing a decision, from `search_tasks` with `decision`",
      +  "items": {
      +    "$ref": "#/$defs/DecisionInForceView"
      +  },
      +  "title": "Decisions",
      +  "type": "array"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "key",
      -  "title",
      -  "description",
      -  "archived_at",
      -  "attributes",
      -  "index"
      -]New value: +[
      +  "key",
      +  "title",
      +  "description",
      +  "archived_at",
      +  "attributes",
      +  "decisions",
      +  "index"
      +]
  2. Addedv0.5.2

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and openWorldHint=false, covering the safety profile. The description adds the contents of the returned document, but the unknown-key refusal is already stated in the parameter schema, and a dedicated output schema exists, so little is added beyond structured fields.

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?

Two short sentences with the action front-loaded; the enumeration of return fields is dense but scannable. The second sentence about `list_projects` earns its place as a key-sourcing hint, though the phrasing 'index of the project's case' is slightly opaque.

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?

For a one-parameter read tool with full schema coverage and an output schema, the definition is essentially complete; the return-field enumeration is mildly redundant given the output schema, but nothing an agent needs to call it is missing.

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 100% and the single `key` parameter is fully documented in-schema, including case-insensitivity, example, and the `project_not_found` error. The description adds no syntax or format detail beyond what the schema already provides, so baseline 3 applies.

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?

States a specific verb and resource ('Returns one project by its key') and enumerates the payload, which immediately distinguishes it from the sibling 'list_projects'. An agent can tell single-fetch from bulk-list without opening either schema.

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 points to `list_projects` as the source of valid keys, giving the agent a concrete path to satisfy the required `key`. It does not spell out when-not to use this tool or name other alternatives (e.g. search_tasks), but the single-vs-list distinction is clear.

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