Skip to main content
Glama

retrieve_cycle

Retrieve a specific cycle's details from a Plane project by providing project and cycle IDs. Returns the cycle object.

Instructions

Retrieve a cycle by ID.

Args: workspace_slug: The workspace slug identifier project_id: UUID of the project cycle_id: UUID of the cycle

Returns: Cycle object

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
cycle_idYes
project_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNo
nameYes
projectNo
versionNo
end_dateNo
owned_byNo
timezoneNo
workspaceNo
created_atNo
created_byNo
deleted_atNo
logo_propsNo
sort_orderNo
start_dateNo
updated_atNo
updated_byNo
view_propsNo
archived_atNo
descriptionNo
external_idNo
total_issuesNo
backlog_issuesNo
started_issuesNo
external_sourceNo
total_estimatesNo
cancelled_issuesNo
completed_issuesNo
unstarted_issuesNo
progress_snapshotNo
started_estimatesNo
completed_estimatesNo
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It indicates a read operation ('Retrieve') and states the return type ('Cycle object'), but does not disclose error behavior, permission requirements, or any side effects. This is adequate for a simple retrieval tool but lacks depth.

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 concise and well-structured with an args/returns format. However, the inclusion of workspace_slug, which is not in the schema, introduces unnecessary clutter. Otherwise, every sentence earns its place.

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?

Although an output schema exists, the description is incomplete due to the workspace_slug mismatch with the input schema. It does not explain whether workspace_slug is required, optional, or extraneous, which could mislead the agent. For a simple retrieval tool, the description should clarify the parameter discrepancy and any workspace scoping.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 0% description coverage, requiring the description to compensate. However, the description lists 'workspace_slug' as a parameter while the schema only includes project_id and cycle_id, and additionalProperties is false. This inconsistency confuses rather than clarifies. The descriptions for project_id and cycle_id are minimal ('UUID of...'), providing only slightly more than the schema's string type.

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 'Retrieve a cycle by ID' with a specific verb and resource, which distinguishes it from sibling tools like create_cycle, update_cycle, delete_cycle, and list_cycles. The parameter names further clarify the 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 implies usage when you have a cycle ID and need the full cycle object. It does not explicitly mention alternatives like list_cycles, but the context is clear given the tool name and purpose. No exclusions or prerequisites are stated, so it falls short of a 5.

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/leigangzhang/plane-mcp-server-adapter'

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