Skip to main content
Glama

update_module

Idempotent

Update a module's details including name, description, dates, status, lead, and members using its ID.

Instructions

Update a module by ID.

Args: workspace_slug: The workspace slug identifier project_id: UUID of the project module_id: UUID of the module name: Module name description: Module description start_date: Module start date (ISO 8601 format) target_date: Module target/end date (ISO 8601 format) status: Module status (backlog, planned, in-progress, paused, completed, cancelled) lead: UUID of the user who leads the module members: List of user IDs who are members of the module external_source: External system source name external_id: External system identifier

Returns: Updated Module object

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
leadNo
nameNo
statusNo
membersNo
module_idYes
project_idYes
start_dateNo
descriptionNo
external_idNo
target_dateNo
external_sourceNo

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 cover mutability and safety. Description adds return type and parameter list but doesn't clarify partial update behavior or any side effects, which is typical for update operations.

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 well-structured with a clear opening sentence followed by a parameter list. It's reasonably concise but slightly longer due to the parameter listing, yet every sentence is informative.

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

Completeness4/5

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

Given the complexity of 11 parameters and the presence of an output schema, the description adequately covers what the tool does, what parameters mean, and what is returned. It doesn't cover error conditions or permission requirements, but these are less critical for an update tool.

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

Parameters5/5

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

With 0% schema description coverage, the description provides detailed explanations for all 11 parameters, including format hints (ISO 8601), status values, and user ID types, fully compensating for the schema gap.

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?

Description clearly states 'Update a module by ID' with a full list of updatable fields, distinguishing it from sibling tools like retrieve_module (read), create_module (create), or delete_module (delete).

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?

Implicitly clear that this tool updates an existing module, but lacks explicit guidance on when to use vs alternatives or prerequisites like needing the module to exist.

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