Skip to main content
Glama

retrieve_cycle

Read-only

Retrieve detailed information about a specific project cycle by providing the project ID and cycle ID.

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?

Annotations already provide readOnlyHint=true and openWorldHint=true, so the description's behavioral disclosure is adequate. It adds a return type hint but does not detail pagination, error behavior, or other side effects beyond what annotations imply.

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 short and structured as a docstring with Args and Returns sections. It is front-loaded with the main purpose. However, the inclusion of a non-existent parameter slightly detracts from conciseness.

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

Completeness3/5

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

Given the tool's simplicity and the presence of output schema and annotations, the description covers the basic purpose and parameters. However, it lacks context about what a cycle is and includes an erroneous parameter, limiting completeness.

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 description lists 'workspace_slug' as an argument, but the input schema does not include it, which is misleading. It does provide type hints (UUID) for the two schema parameters, but schema coverage is 0%, so the description only partially compensates and introduces an error.

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 tool name 'retrieve_cycle' and description 'Retrieve a cycle by ID' clearly state the action and resource. However, the description does not distinguish it from sibling retrieve tools like 'retrieve_project' or 'retrieve_module'.

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?

No guidance is provided on when to use this tool versus alternatives, nor are there any conditions or exclusions mentioned. The description is purely functional without usage context.

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/Bl4nk44/plane-ce-mcp'

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