Skip to main content
Glama

retrieve_module

Read-only

Get a specific module by providing project and module IDs. Returns detailed module information.

Instructions

Retrieve a module by ID.

Args: workspace_slug: The workspace slug identifier project_id: UUID of the project module_id: UUID of the module

Returns: Module object

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
module_idYes
project_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNo
leadNo
nameYes
statusNo
projectNo
workspaceNo
created_atNo
created_byNo
deleted_atNo
logo_propsNo
sort_orderNo
start_dateNo
updated_atNo
updated_byNo
view_propsNo
archived_atNo
descriptionNo
external_idNo
target_dateNo
total_issuesNo
backlog_issuesNo
started_issuesNo
external_sourceNo
cancelled_issuesNo
completed_issuesNo
description_htmlNo
description_textNo
unstarted_issuesNo
Behavior3/5

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

Annotations already indicate readOnlyHint=true, so the description's 'retrieve' is consistent. Description adds no extra behavioral details (e.g., idempotency, rate limits), but doesn't need to given annotation coverage.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Description is short and front-loaded, but includes an erroneous parameter (workspace_slug) that undermines accuracy. Conciseness is good, but the error reduces effectiveness.

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?

For a simple retrieval tool with annotations and output schema, the description is mostly adequate. However, the mismatch between mentioned arguments and actual schema parameters leaves some incompleteness.

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?

Schema coverage is 0%, so description should clarify parameters. It incorrectly includes workspace_slug not in schema, and while it specifies UUIDs for project_id and module_id, it doesn't describe allowed formats or constraints comprehensively.

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?

Description clearly states 'Retrieve a module by ID' with verb and resource. However, it mentions workspace_slug as an argument that is not in the input schema, causing slight confusion.

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 on when to use this tool versus alternatives like retrieve_project or other retrieve tools. No mention of context 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/Bl4nk44/plane-ce-mcp'

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