Skip to main content
Glama

toggle-module-publish

Toggles the published status of a Canvas module. Provide course ID and module ID to publish or unpublish.

Instructions

Publish/unpublish a module (toggles the current published state).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
courseIdYesThe ID of the course
moduleIdYesThe ID of the module
Behavior4/5

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

The description discloses the toggle behavior, which is a key behavioral trait not fully captured by the annotations or schema. The annotation only provides destructiveHint=false, so the description adds that the tool flips the publish state rather than setting a specific value.

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

Conciseness5/5

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

The description is a single sentence, front-loaded with the action and resource, and contains no filler. Every word earns its place.

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?

For a simple 2-param toggle tool with no output schema and a clear annotation, the description is sufficient. It fully explains the action without unnecessary detail, though it omits potential side effects or prerequisites, which are likely not critical for this simple operation.

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 schema already covers both parameters with clear descriptions ('The ID of the course' and 'The ID of the module'). The description adds no extra parameter information, so it is at the baseline 3.

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 a specific action (publish/unpublish) on a specific resource (module) and explicitly notes 'toggles the current published state,' distinguishing it from update-module or delete-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?

The description offers no guidance on when to use this tool versus alternatives like update-module or create-module. There is no mention of exclusions, conditions, or preferred scenarios.

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/r-huijts/canvas-mcp'

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