Skip to main content
Glama

Get a Redmine issue relation

get_issue_relation
Read-onlyIdempotent

Fetch a specific Redmine issue relation by ID to view its details. This read-only tool returns the relation's fields and links, with access controlled by Redmine permissions.

Instructions

Read one visible Redmine issue relation from GET /relations/:id.json for the configured API user. The required relation_id is one positive safe numeric ID. This route has no query controls. The result contains only documented relation fields and safe base-path browser links for valid issue and relation IDs, preserving Redmine's explicit null or omitted delay. Redmine accepts ordinary API authentication, enforces visibility for both linked issues, and may return HTTP 401, 403, or 404. This tool never changes Redmine data.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
relation_idYesPositive Redmine issue relation ID

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
urlNo
delayNo
issueIdYes
issueUrlNo
issueToIdYes
issueToUrlNo
relationTypeYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.4/5.0
Behavior5/5

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

Beyond the annotations, the description discloses authentication expectations ('ordinary API authentication'), visibility constraints on both linked issues, possible HTTP 401/403/404 outcomes, and preservation of Redmine's null/omitted delay. It also states that no data is changed, reinforcing the read-only annotation. No contradiction with annotations exists.

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?

The description leads with the purpose, then quickly covers the required parameter and behavioral caveats. It is organized and mostly economical, though the final 'never changes Redmine data' sentence largely duplicates the readOnlyHint/destructiveHint annotations.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With one well-constrained parameter and an output schema present, the description covers the remaining operational context: visibility rules, auth, error codes, and result contents. It is complete enough for an agent to decide whether to call the tool and to know what to expect.

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 coverage is 100%, so the schema already documents relation_id as a positive integer with bounds. The description adds little beyond the word 'safe' and the requirement that the ID be a positive numeric ID; no parameter semantics are missing.

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 ('Read'), a precise resource ('Redmine issue relation'), and the exact endpoint ('GET /relations/:id.json'), plus the scope 'one visible ... for the configured API user.' The singularity of the resource and endpoint distinguish it from listing siblings such as list_issue_relations, even though that sibling is not named.

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 clearly sets the invocation context: use this tool to read a single, visible issue relation by relation_id for the configured API user. It also notes there are no query controls and that visibility is enforced for both linked issues. It does not explicitly name alternatives like list_issue_relations for multi-result needs, so it stops short of the strongest usage guidance.

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