Skip to main content
Glama

get_document

Fetch a single OpenProject document by its ID to access its full data directly for review or processing.

Instructions

Get a single document by id.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
document_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
titleYes
projectYes
can_updateYes
created_atYes
project_idYes
descriptionYes
attachment_countYes

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed4 schema fields changedv0.3.7
    • addedInput schema / additionalProperties
      Added value: +false
    • removedOutput schema / properties / attachments_url
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "string"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "title": "Attachments Url"
      -}
    • removedOutput schema / properties / url
      Removed value: -{
      -  "title": "Url",
      -  "type": "string"
      -}
    • changedOutput schema / required
      Previous value: -[
      -  "id",
      -  "title",
      -  "project_id",
      -  "project",
      -  "description",
      -  "created_at",
      -  "attachment_count",
      -  "attachments_url",
      -  "can_update",
      -  "url"
      -]New value: +[
      +  "id",
      +  "title",
      +  "project_id",
      +  "project",
      +  "description",
      +  "created_at",
      +  "attachment_count",
      +  "can_update"
      +]
  2. Addedv0.3.3
  3. Removedv0.3.0
  4. First observedv0.2.2

TDQS

A3.6/5.0
Behavior2/5

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

No annotations are provided, so the description must disclose behavior. It only says 'Get a single document,' which implies read-only but omits details about error handling, authentication needs, or whether the document must exist. This is minimal and insufficient for a tool with zero annotation support.

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?

The description is a single concise sentence with no unnecessary words. It is front-loaded and efficiently communicates the tool's core function.

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 simple get tool with one parameter and an output schema, the description is largely complete. It specifies the action and required input, and the output schema handles return details. The only gap is not mentioning the relationship to list_documents, but that is a usage nuance rather than a completeness failure.

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 description must compensate. The phrase 'by id' indicates the parameter is an identifier, matching the schema's 'document_id' field. However, it adds little beyond the schema's existing title, lacking context on how to obtain the ID or any formatting constraints.

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 clearly states the action and resource: 'Get a single document by id.' It uses a specific verb (get) with a resource (document) and scoping (by id), distinguishing it from siblings like list_documents.

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 implies usage requires a document ID, but does not explicitly explain when to use this vs alternatives (e.g., list_documents to obtain IDs). No exclusions or alternative tools are mentioned, leaving the agent to infer from the sibling list.

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

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/jtauschl/openproject-ce-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server