Skip to main content
Glama

publish_module

Make a Canvas module visible to students. Publishes the module container; individual items keep their own published state.

Instructions

Publish a module (makes it visible to students). Note: this publishes the module container only — individual items retain their own published state.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
course_idYesCanvas course ID
module_idYesModule ID
Behavior4/5

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

With no annotations, the description carries the full burden of behavioral disclosure. It does disclose a key side-effect: individual items retain their own published state. This is valuable nuance, though it doesn't mention idempotency, permissions, or error behavior.

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 two short sentences: the first states action and effect, the second adds a critical caveat. There is zero filler or redundancy, and it is front-loaded with the verb and resource.

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 two-parameter operation with no output schema, the description covers the essential purpose and a critical nuance about its scope. It doesn't describe the response format or error conditions, but those are not required here.

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?

Both parameters (course_id, module_id) are fully described in the input schema (100% coverage). The description adds no additional parameter-level detail, so the baseline of 3 is appropriate.

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 uses a specific verb 'publish' with resource 'module' and immediately clarifies the effect ('makes it visible to students'). The note about publishing only the container distinguishes it from item-level publish operations and sibling tools like update_module.

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 use when you want to publish a module, and the note about container-only sets clear expectations about what the tool does not do. However, it does not explicitly name alternatives or state when not to use it, so it stops short of a full 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/hughsibbele/Canvas-Agent'

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