Skip to main content
Glama
dev-in-black

OpenProject MCP Server

by dev-in-black

list_work_package_relations

Retrieve all relationships for a work package to understand task dependencies and connections within OpenProject.

Instructions

Get all relations for a work package.

Args:
    work_package_id: Work package ID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
work_package_idYes

Implementation Reference

  • Core handler function that fetches the list of relations for a given work package ID using the OpenProjectClient.
    async def list_work_package_relations(work_package_id: int) -> dict[str, Any]:
        """Get all relations for a work package.
    
        Args:
            work_package_id: Work package ID
    
        Returns:
            Collection of relations (parent, blocks, relates, etc.)
        """
        client = OpenProjectClient()
    
        try:
            result = await client.get(f"work_packages/{work_package_id}/relations")
            return result
        finally:
            await client.close()
  • MCP tool registration using @mcp.tool() decorator. This is the entry point for the tool, delegating to the core implementation in relations.py.
    @mcp.tool()
    async def list_work_package_relations(work_package_id: int):
        """Get all relations for a work package.
    
        Args:
            work_package_id: Work package ID
        """
        return await relations.list_work_package_relations(
            work_package_id=work_package_id
        )
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states it 'gets' relations, implying a read-only operation, but doesn't specify permissions needed, rate limits, pagination, or what 'relations' entail (e.g., types, format). This leaves significant gaps for safe and effective use.

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 is brief and front-loaded with the core purpose, followed by a simple parameter list. It avoids unnecessary words, though the 'Args:' section is somewhat redundant given the schema.

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

Completeness2/5

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

For a tool with no annotations, no output schema, and low schema coverage, the description is insufficient. It doesn't explain what 'relations' are, how results are returned, or error handling, leaving the agent with incomplete context for reliable invocation.

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 description adds minimal semantics by naming the parameter ('work_package_id') and indicating it's a required ID, but the schema already defines it as a required integer with a title. With 0% schema description coverage, this doesn't fully compensate—it lacks details like ID format or sourcing.

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?

The description clearly states the action ('Get all relations') and resource ('for a work package'), making the purpose understandable. However, it doesn't differentiate from sibling tools like 'get_relation' (singular) or 'create_relation', which could cause confusion about when to use each.

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?

The description provides no guidance on when to use this tool versus alternatives like 'get_relation' (singular) or 'create_relation'. It mentions the required parameter but offers no context about prerequisites, typical use cases, or exclusions.

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

Install Server

Other Tools

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/dev-in-black/openproject-mcp'

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