codex_canvas_mcp
Codex Canvas MCP
一个可移植的本地 MCP 服务器,让兼容客户端能够读取 Canvas,并且仅在通过多项独立安全检查之后,才能创建常见的课程内容。
安全模型
在本地凭据设置完成后,Canvas 读取功能默认可用。
写入功能默认禁用。
每次内容写入都需要启用本地策略、精确的按课程允许列表匹配、精确的确认文本,以及 MCP 客户端中的批准。
图片上传增加了载荷门控:只有位于一个已配置的受信任文件夹内、由本地拥有的 PNG、JPEG 或 WebP 文件,且大小不超过 10 MiB,才能被发送。
不存在通用的 Canvas 写入工具。
凭据保存在 1Password 中,并可选择保存在 macOS 钥匙串中。它们不应出现在此仓库或客户端配置中。
每个内容工具都被标记为变更性和破坏性操作,以便兼容客户端可以要求批准。本地服务器还会拒绝调用,除非其精确确认与所请求的操作匹配,例如 APPROVE CANVAS MODULE WRITE course <course_id>。
评分量规创建接受同源的 Canvas 作业 URL、作业模块项目 URL,或包含 assignment_id 查询参数的课程 URL。在课程和作业解析完成后,查询字符串和片段将被忽略。该 URL 永远不会绕过课程策略:其课程 ID 仍必须被明确列入允许列表,并且评分量规创建需要 APPROVE CANVAS RUBRIC WRITE course <course_id>。该工具拒绝替换现有的作业评分量规,要求为每个标准和评级提供描述,并要求评分量规分数与作业分数一致。
Related MCP server: canvas-lms
包含内容
工具 | 能力 | 默认状态 |
| 读取已认证的个人资料 | 可用 |
| 读取一个课程的模块和项目 | 可用 |
| GET 一个规范化的 Canvas API v1 路径 | 可用 |
| 检查本地策略状态 | 可用 |
| 从已配置的受信任文件夹上传一个已验证的图片 | 已阻止 |
| 创建或更新一个页面 | 已阻止 |
| 创建一个模块 | 已阻止 |
| 将一个内容项目放入模块 | 已阻止 |
| 创建一个作业 | 已阻止 |
| 从 Canvas URL 创建并附加一个作业评分量规 | 已阻止 |
| 创建一个讨论 | 已阻止 |
| 创建一个经典测验 | 已阻止 |
| 向经典测验添加一个问题 | 已阻止 |
| 删除一个页面 | 已阻止 |
| 删除一个作业 | 已阻止 |
| 删除一个讨论 | 已阻止 |
| 删除一个经典测验 | 已阻止 |
| 删除一个模块及其项目放置 | 已阻止 |
设置新 Mac
先决条件:Python 3.11 或更高版本、1Password CLI、一个只能读取预期 Canvas 凭据项目的 1Password 服务账户,以及一个具有适合您工作的最低权限的 Canvas API 令牌。
克隆并安装到隔离环境中:
git clone https://github.com/mrchris-ai/codex_canvas_mcp.git cd codex_canvas_mcp python3 -m venv .venv . .venv/bin/activate python -m pip install --upgrade pip python -m pip install -e .创建一个 1Password 项目,其隐藏字段包含 Canvas API 令牌。仅授予服务账户对包含该项目的保险库/项目的读取权限。记录保险库名称、项目名称或 ID,以及隐藏字段标签;不要将其值放入此仓库。
选择一种服务账户令牌传递方式:
对于短期 shell 会话,通过您的本地密钥启动器向 MCP 服务器进程提供
OP_SERVICE_ACCOUNT_TOKEN。在 macOS 上,将该令牌存储在钥匙串中,并配置非机密查找标签。示例命令(它会安全地提示输入;不要将令牌放在命令行上):
security add-generic-password -U -s "your-service-label" -a "your-account-label" -w
使用以下非机密值配置服务器进程:
变量
用途
CANVAS_BASE_URLCanvas HTTPS 源,例如
https://school.instructure.comCANVAS_OP_VAULT1Password 保险库名称或 ID
CANVAS_OP_ITEMCanvas 凭据项目名称或 ID
CANVAS_OP_FIELD隐藏令牌字段标签;默认为
credentialCANVAS_KEYCHAIN_SERVICE未使用
OP_SERVICE_ACCOUNT_TOKEN时的 macOS 钥匙串服务标签CANVAS_KEYCHAIN_ACCOUNT未使用
OP_SERVICE_ACCOUNT_TOKEN时的 macOS 钥匙串账户标签CANVAS_IMAGE_UPLOAD_ROOT允许图片上传的唯一本地文件夹的绝对路径
仅测试协议和安全门控,不联系 Canvas 或读取凭据:
python -m unittest discover -s tests -v printf '%s\n' '{"jsonrpc":"2.0","id":1,"method":"tools/list"}' | python -m canvas_mcp将 stdio 服务器添加到 Codex。项目级形式为:
[mcp_servers.canvas] command = "/absolute/path/to/codex_canvas_mcp/.venv/bin/python" args = ["-m", "canvas_mcp"] [mcp_servers.canvas.env] CANVAS_BASE_URL = "https://school.instructure.com" CANVAS_OP_VAULT = "your-vault" CANVAS_OP_ITEM = "your-item" CANVAS_OP_FIELD = "credential" CANVAS_KEYCHAIN_SERVICE = "your-service-label" CANVAS_KEYCHAIN_ACCOUNT = "your-account-label" CANVAS_IMAGE_UPLOAD_ROOT = "/absolute/path/to/reviewed/canvas-images"将其放入受信任项目的
.codex/config.toml或您的个人 Codex 配置中。不要添加机密值。更改 MCP 配置后重新启动或打开新任务,然后在请求 Canvas 数据之前验证列出的工具。
ChatGPT 兼容性
此仓库为 Codex 和其他支持本地 stdio MCP 的客户端实现了一个本地 stdio MCP 服务器。当前的 ChatGPT 自定义应用不会直接连接到本地 stdio 服务器。OpenAI 当前的指导是通过 Secure MCP Tunnel 暴露私有本地 MCP(或部署经过审查的远程 MCP 端点),具体取决于套餐和工作区管理员可用性。不要将此进程直接暴露到公共互联网。
在尝试 ChatGPT 设置之前,请参阅 ChatGPT 中的开发者模式和 MCP 应用;可用性和批准行为可能会发生变化。
启用内容创建工具
除非特定任务需要,否则保持写入功能关闭。
将
config/write-policy.example.json复制到仓库之外的位置。仅添加批准用于内容创建的精确 Canvas 课程 ID。
将
enabled设置为true并限制文件权限:chmod 600 /absolute/private/path/write-policy.json将
CANVAS_WRITE_POLICY=/absolute/private/path/write-policy.json添加到 MCP 服务器环境。重新启动客户端并调用
canvas_get_write_policy以验证生效的策略。对于每次内容写入,审查精确的目标和载荷。提供特定于操作的确认短语,并在客户端中批准变更性操作。
任务完成后再次禁用该策略。
如果变量缺失、文件不存在、权限比 0600 更宽松、写入被禁用,或课程不在允许列表中,服务器将拒绝写入。
启用图片上传
图片上传使用相同的本地写入策略和精确课程允许列表,外加 CANVAS_IMAGE_UPLOAD_ROOT。该工具拒绝相对路径、符号链接、该根目录之外的文件、非当前用户拥有的文件、不支持的图片类型、二进制签名与扩展名不一致的文件,以及大于 10 MiB 的文件。精确确认为 APPROVE CANVAS IMAGE UPLOAD course <course_id>。
Canvas 使用文档化的三步上传交换:通过已认证的 API 初始化课程文件,将图片(不带 Canvas 访问令牌)发送到 Canvas 返回的 HTTPS 存储 URL,然后对返回的同源 Canvas 完成位置进行认证。该工具随后读取 /api/v1/courses/<course_id>/files/<file_id> 并检查 MIME 类型和大小,然后返回一个持久的课程预览路径。它永远不会返回存储签名或文件下载验证器 URL。
当前的创建边界
此项目是此 Mac 上受支持聊天所使用的共享本地 Canvas MCP 的事实来源。在正常的策略和批准门控之后,它可以创建页面、模块和模块项目、作业和作业评分量规、讨论,以及带问题的经典测验。它还提供针对页面、作业、讨论、经典测验和模块的资源特定删除工具;删除模块会移除其项目放置,但不会移除底层课程内容。其唯一的本地文件能力是上述受载荷门控的图片上传器。通用文件上传、New Quizzes 以及账户/课程管理仍然不受支持。
有关实现和端到端验证记录,请参阅 docs/2026-08-06-content-authoring-extension.md。
有关图片上传威胁模型和验证记录,请参阅 docs/2026-08-16-image-upload-extension.md。
开发
python -m pip install -e .
python -m unittest discover -s tests -v
python -m compileall -q src tests测试模拟网络和凭据边界。请参阅 AGENTS.md 了解贡献者必须保留的不变量,并参阅 ROADMAP.md 了解有意推迟的管理功能。
Available Tools
11 toolscanvas_create_assignmentADestructive
Create exactly one Canvas assignment in an approved course. Disabled by default and requires explicit confirmation.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | ||
| course_id | Yes | ||
| published | No | ||
| description | No | ||
| confirmation | Yes | ||
| points_possible | No | ||
| submission_types | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds meaningful behavioral context beyond annotations: it notes the tool is 'disabled by default' and 'requires explicit confirmation,' which are important operational traits not captured by the readOnly/idempotent/destructive hints. It also clarifies the one-at-a-time creation behavior, providing useful transparency.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single front-loaded sentence with no filler or repetition. Every word earns its place, making it highly concise and well-structured.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Despite the simplicity of the description, the tool has 7 parameters and no output schema, yet the description omits return value behavior and most parameter details. It does not explain what 'approved course' means or how confirmation works, leaving the agent without enough context to invoke it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate, but it only references the 'confirmation' parameter. It does not explain the meaning or constraints of course_id, name, published, description, points_possible, or submission_types, leaving significant semantic gaps.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Create exactly one Canvas assignment in an approved course,' specifying the verb (create), resource (Canvas assignment), and scope (exactly one, in an approved course). This distinguishes it from sibling creation tools like canvas_create_module or canvas_create_discussion.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage when creating a Canvas assignment and mentions preconditions ('approved course', 'requires explicit confirmation'), but it does not explicitly name alternative tools or state when not to use this tool. The guidance is contextually clear but lacks explicit exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
canvas_create_classic_quizADestructive
Create exactly one Canvas Classic Quiz in an approved course. New Quizzes are not supported by this tool. Disabled by default and requires explicit confirmation.
| Name | Required | Description | Default |
|---|---|---|---|
| title | Yes | ||
| course_id | Yes | ||
| published | No | ||
| quiz_type | No | practice_quiz | |
| description | No | ||
| confirmation | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already mark the tool as destructive (destructiveHint=true) and non-read-only. The description adds valuable context beyond this: the restriction to Classic Quizzes, the requirement for an approved course, and the need for explicit confirmation. It does not contradict the annotations and enriches behavioral understanding.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three sentences long, front-loaded with the main purpose, and each sentence adds distinct information (what it does, limitation, requirement). No filler or repetition; it is highly efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool complexity (6 params, no output schema), the description covers the core behavioral aspects: what is created, the Classic vs New distinction, and the confirmation requirement. It omits specifics about return values or quiz_type nuances, but these are secondary to the main purpose and reasonably supplemented by the schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 0%, so the description must compensate for parameter meanings. It only references the 'confirmation' parameter and indirectly references course_id via 'approved course', but leaves title, published, quiz_type, and description without any added context. This is insufficient for a tool with 6 parameters where the schema alone provides limited guidance.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action: 'Create exactly one Canvas Classic Quiz'. It specifies the resource type (Canvas Classic Quiz) with the verb 'create', and distinguishes from sibling tools by explicitly stating it is for Classic Quizzes, not New Quizzes, and from quiz_question by focusing on the quiz itself.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides clear context: the tool works only in an 'approved course', is for Classic Quizzes (not New Quizzes), and 'requires explicit confirmation'. However, it does not explicitly name alternative tools for other quiz types or when not to use this tool, leaving a small gap.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
canvas_create_classic_quiz_questionADestructive
Add one question to an existing Canvas Classic Quiz in an approved course. Disabled by default and requires explicit confirmation.
| Name | Required | Description | Default |
|---|---|---|---|
| answers | No | ||
| quiz_id | Yes | ||
| course_id | Yes | ||
| confirmation | Yes | ||
| question_name | Yes | ||
| question_text | Yes | ||
| question_type | Yes | ||
| points_possible | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations indicate destructiveHint: true, but the description adds crucial context by stating 'Disabled by default and requires explicit confirmation', which explains the need for a confirmation parameter. The mention of 'approved course' also signals authorization requirements, going beyond the annotation hints.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, dense sentence that conveys the core purpose and key constraints without waste. Every phrase adds value: 'Add one question', 'existing', 'approved course', and 'disabled by default' all contribute essential information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With 8 parameters (6 required) and no output schema, this description is far too brief to provide adequate context. It fails to explain any parameter semantics beyond confirmation, the behavior of question_type enum, or what happens on success/failure, leaving the agent without sufficient guidance for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, and the description provides almost no parameter details. It only vaguely references 'explicit confirmation' (mapping to the confirmation parameter) and 'existing Canvas Classic Quiz' (implying quiz_id), but the other six required parameters (course_id, question_name, question_text, question_type, etc.) are left entirely to the schema, which lacks descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Add one question to an existing Canvas Classic Quiz in an approved course', specifying the verb (Add), resource (question), and target (existing quiz). This distinguishes it from siblings like canvas_create_classic_quiz, which creates a quiz, and other create_* tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The phrase 'to an existing Canvas Classic Quiz' provides clear context for when to use this tool (for adding questions to quizzes that already exist). It does not explicitly name alternatives or exclusions, but the 'existing' qualifier implies not for creating quizzes, which is handled by a sibling.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
canvas_create_discussionADestructive
Create exactly one Canvas discussion in an approved course. Disabled by default and requires explicit confirmation.
| Name | Required | Description | Default |
|---|---|---|---|
| title | Yes | ||
| message | Yes | ||
| course_id | Yes | ||
| published | No | ||
| confirmation | Yes | ||
| discussion_type | No | threaded |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare the tool as non-read-only and destructive, but the description adds that it is 'disabled by default' and 'requires explicit confirmation,' which are important behavioral constraints beyond the schema. This helps the agent understand prerequisites and that the tool will not execute without explicit user confirmation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is only two sentences, front-loading the primary purpose and immediately adding a critical constraint. Every word earns its place with no unnecessary detail, making it highly efficient and easy to parse.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no output schema, the description does not explain return values or error behavior. It also leaves the 'confirmation' parameter value unspecified and does not clarify what 'approved course' means operationally. However, it does disclose the most critical gating (approval and confirmation), making it minimally adequate for a simple creation tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema has 0% description coverage for all parameters, and the description only adds meaning to the 'confirmation' parameter by indicating it must be explicitly provided. It does not explain expected values for confirmation or clarify the semantics of title, message, course_id, published, or discussion_type, so it fails to compensate for the lack of schema descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Create exactly one Canvas discussion in an approved course,' identifying the verb (create), resource (discussion), and scope (approved course). This distinguishes it from sibling tools that create modules, assignments, or quizzes.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides clear context by noting the tool requires an 'approved course' and 'explicit confirmation,' setting prerequisites and conditions for use. However, it does not explicitly mention when to use this tool over alternatives or exclude other creation tools, so it lacks explicit usage comparisons.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
canvas_create_moduleADestructive
Create exactly one Canvas module in an approved course. Disabled by default and requires explicit confirmation.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | ||
| position | No | ||
| course_id | Yes | ||
| published | No | ||
| confirmation | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate readOnlyHint=false and destructiveHint=true, so the tool is known to be mutating. The description adds valuable context: it is 'disabled by default' and requires 'explicit confirmation', explaining why it might be unavailable. This goes beyond the annotations without contradicting them.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence that is direct and free of fluff. It front-loads the verb and resource, and every word adds meaning. No redundancy or unnecessary detail.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool has 5 parameters, 3 required, and no output schema, so the description needs to cover return behavior, parameter details, and error states. It provides only minimal context (approved course, confirmation) and omits crucial information like success/failure behavior, response format, and implications of the position/published flags. This is insufficient for a create operation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate for documenting parameters. It only mentions 'explicit confirmation' (mapping to the confirmation parameter) and 'approved course' (vaguely relating to course_id), but does not explain name, position, published, or the format of confirmation. The description fails to provide essential parameter semantics.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool creates exactly one Canvas module, using a specific verb ('create') and resource ('module'). This distinguishes it from sibling tools like canvas_create_module_item, which creates items within a module. The phrase 'in an approved course' adds scope, making the purpose unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description mentions prerequisites ('approved course') and a requirement for 'explicit confirmation', which implies the tool is for special cases and not a default action. However, it does not explicitly contrast with alternative tools (e.g., canvas_create_module_item) or state when not to use it. This is clear context but lacks explicit exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
canvas_create_module_itemADestructive
Add one existing Canvas content item or external URL to an existing module in an approved course. Disabled by default and requires explicit confirmation.
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | ||
| title | Yes | ||
| new_tab | No | ||
| page_url | No | ||
| position | No | ||
| course_id | Yes | ||
| module_id | Yes | ||
| content_id | No | ||
| confirmation | Yes | ||
| external_url | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate a destructive, non-read-only operation. The description adds valuable context beyond annotations by specifying it is 'Disabled by default' and 'requires explicit confirmation', which are crucial behavioral traits. It also mentions the prerequisite of an approved course. This goes beyond simply restating the safety profile.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two concise sentences, front-loaded with the core purpose and containing no redundant information. It efficiently communicates the key action and the critical confirmation requirement.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With 10 parameters and no output schema, the description is too brief to be complete. It omits return value expectations, error conditions, or side effects beyond the destructive hint. It does not explain conditional parameter relationships (e.g., external_url vs content_id) or behavior when adding duplicates.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate. It hints at the type parameter (content item vs external URL) and emphasizes the confirmation parameter. However, it does not clarify other parameters like position, new_tab, or page_url, leaving many fields semantically unexplained.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's function: adding an existing Canvas content item or external URL to a module. It uses a specific verb ('Add') and resource ('module item'), and distinguishes from siblings like canvas_create_module by emphasizing the item already exists.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies when to use this tool (for existing content items) but does not explicitly state when not to use it or name alternatives. It gives context about needing an approved course and explicit confirmation, but lacks explicit guidance on choosing between this and sibling tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
canvas_get_current_userARead-only
Read the authenticated Canvas user's profile. Read-only.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description repeats the readOnlyHint annotation by saying 'Read-only' but adds useful context by specifying 'authenticated user' scope. It does not disclose error handling, rate limits, or response format, which is acceptable given the annotation and simplicity.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two short sentences with no filler. It states the action and the read-only nature directly and front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a zero-parameter, read-only tool, the description is sufficient for basic understanding. It doesn't describe the return payload, but the simplicity and annotations compensate. A brief mention of returned fields would make it complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has no parameters, so schema coverage is 100% vacuously. Per the guidelines, a zero-parameter tool gets a baseline of 4, and the description adds no unnecessary parameter information.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Read the authenticated Canvas user's profile' with a specific verb (read) and resource (authenticated user's profile). It distinguishes from sibling write tools like canvas_create_module or canvas_write_page.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The intended usage is implied by the name and description – if you need the current user's profile, this is the tool. However, no explicit alternatives or exclusions are given, and it doesn't differentiate from canvas_read_api which could also be used for reading.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
canvas_get_write_policyARead-only
Show write-policy state and approved course IDs. Does not expose credentials.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations declare readOnlyHint=true, and the description adds value by noting 'Does not expose credentials' and specifying the exact data returned. This goes beyond the annotation, providing safety context about what information is included or excluded.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two concise sentences, front-loaded with the core function and a useful safety note. Every word earns its place, and there is no redundant or ambiguous wording.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a no-parameter, read-only getter without an output schema, the description fully covers what the tool does and what it returns. The additional credential-safety note adds helpful context, leaving no meaningful gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has zero parameters, so the schema fully covers the input structure. Since no parameters exist, the description need not explain parameter semantics; the baseline of 4 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's function: showing write-policy state and approved course IDs. It uses a specific verb ('Show') and resource ('write-policy state'), distinguishing it from sibling tools that handle users, modules, or page operations.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to use this tool versus alternatives. The description does not mention prerequisites, exclusions, or compare with sibling tools like canvas_read_api or canvas_get_current_user, leaving the agent without explicit usage boundaries.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
canvas_list_modulesARead-only
List modules and module items for one Canvas course. Read-only.
| Name | Required | Description | Default |
|---|---|---|---|
| course_id | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, and the description reiterates 'Read-only,' adding little beyond that. It does add the scoping detail 'for one Canvas course,' which implies course_id targets a single course. However, it does not disclose behaviors like pagination, ordering, or what exactly is returned for modules/items. With annotations covering the safety profile, a score of 3 is appropriate.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences immediately state the action and scope, and then note read-only behavior. No filler or redundancy. The information is front-loaded and every word earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's simplicity (one parameter, read-only annotation, no output schema), the description covers the essential purpose, scope, and safety. It tells the agent it will get modules and module items for a single course. It lacks return format or pagination details, but for this level of complexity, the description is largely complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema has one required parameter (course_id) with 0% description coverage. The description adds some meaning by stating 'for one Canvas course,' clarifying that course_id identifies the course and that the tool is scoped to a single course. It also indicates the output will include modules and module items. Yet it does not elaborate on parameter format or constraints beyond what the parameter name and schema already imply.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses the specific verb 'List' with a clear resource ('modules and module items') and scope ('one Canvas course'). This clearly distinguishes it from sibling creation tools like canvas_create_module and canvas_create_module_item, as well as from the more general canvas_read_api.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage (i.e., when you need to list modules/items for a course), and the 'Read-only' note hints it is safe for inspection. However, it does not explicitly state when to use this tool versus alternatives, nor does it provide exclusions or contrast with sibling tools. The guidance is largely implicit.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
canvas_read_apiBRead-only
Read one Canvas REST API v1 path with GET. Cannot make changes.
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | ||
| query | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, and the description reinforces this with 'Cannot make changes.' It adds the HTTP method (GET) and scope (one path), but does not disclose other behaviors like error handling, rate limits, or response format. With the annotation covering safety, this is adequate but not rich.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence, front-loaded with the core purpose, and every word earns its place. 'Read one Canvas REST API v1 path with GET. Cannot make changes.' is maximally concise and structurally clear.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is a generic reader with no output schema, so more context would help, such as mention of arbitrary path coverage or usage hints. The description is adequate for a simple read tool, but it leaves open questions about the query parameter and response shape, making it only a baseline complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate, but it only mentions 'path' without explaining its format or the optional 'query' object. The schema provides a pattern for path, but the description adds no semantic meaning for either parameter, especially query.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool reads one Canvas REST API v1 path using GET, which is a specific verb and resource. It also explicitly says 'Cannot make changes,' distinguishing it from write tools. This satisfies the purpose clarity requirement.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explains what the tool does but gives no guidance on when to use it versus the specific sibling tools like canvas_get_current_user or canvas_list_modules. It does not mention alternatives or exclusions, so the agent receives no usage direction.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
canvas_write_pageADestructive
Create or update exactly one Canvas page. Disabled by default. Requires a local per-course allowlist, exact user confirmation, and approval of this write action in the MCP client. This is not generic Canvas write access.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | ||
| title | Yes | ||
| page_url | No | Existing Canvas page URL slug. Omit to create a page. | |
| course_id | Yes | ||
| published | No | ||
| confirmation | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds significant context beyond the annotations: disabled by default, requires a per-course allowlist, exact user confirmation, and MCP client approval. This goes beyond the simple destructiveHint to explain how the destructive operation is gated and controlled.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three short sentences front-load the purpose first, then constraints, then a clarifying statement. Each sentence conveys essential information with no filler or redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers the purpose, scope, and safety prerequisites, which are the most critical aspects for a gated write tool. It does not elaborate on parameter semantics, but the schema provides some names and defaults, and 'exactly one' sets expectation for behavioral scope.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is only 17% (only page_url is described). The tool description does not explain the meaning of required parameters like confirmation, body, or course_id, and does not compensate for the low schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states a specific verb and resource: 'Create or update exactly one Canvas page.' It also adds scope ('exactly one') and explicitly distinguishes itself from generic write tools, which helps differentiate it from sibling write tools like canvas_create_module.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description clearly indicates when to use this tool (for Canvas page creation/update) and explicitly excludes other write actions ('not generic Canvas write access'). It does not name specific alternatives, but the purpose and exclusions are unambiguous.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
11 tool updates
v0.2.0- First observed
canvas_create_assignment - First observed
canvas_create_classic_quiz - First observed
canvas_create_classic_quiz_question - First observed
canvas_create_discussion - First observed
canvas_create_module - First observed
canvas_create_module_item - First observed
canvas_get_current_user - First observed
canvas_get_write_policy - First observed
canvas_list_modules - First observed
canvas_read_api - First observed
canvas_write_page
TDQS
Scored across 11 tools
Each tool targets a distinct Canvas resource and action: user info, module listing, generic API read, write policy, and specific create operations for pages, modules, module items, assignments, discussions, and quizzes. The quiz and quiz-question pair are clearly hierarchical, and the generic read tool is distinct from the specific list tool.
All tools use the 'canvas_' prefix followed by a verb_noun pattern (get_user, list_modules, create_assignment, etc.). Minor deviations include 'read_api' instead of 'get_api' and 'write_page' instead of 'create_page', but the overall pattern is predictable and consistent.
With 11 tools, the set is well-scoped for a Canvas LMS integration focused on reading course structure and creating content items. Each tool has a clear purpose, and the count falls comfortably in the ideal 3-15 range without feeling bloated.
The tool surface covers reading (user, modules, generic API), creation (pages, modules, module items, assignments, discussions, quizzes, quiz questions), and page updates, but lacks explicit update/delete operations for most created entities. The generic canvas_read_api provides a workaround for reads, but delete operations are entirely absent, leaving a noticeable lifecycle gap.
Maintenance
Related MCP Connectors
MCP server for the Inistate platform: module discovery, entry management, and activity submission.
OAuth-protected, read-only-by-default MCP server for provenance-labeled QuillCaddie project memory.
Experimental MCP server for current empirical verification of explicit public HTTPS endpoint claims.
A MCP server built for developers enabling Git based project management with project and personal…
Related MCP Servers
- FlicenseNot gradedqualityCmaintenanceRead-only MCP server that provides Claude Desktop with access to converted Canvas course exports, including Markdown files, reports, and search tools for local course content.-
- AlicenseNot gradedqualityCmaintenanceMCP server for Canvas LMS with automatic OAuth authentication. Enables interaction with courses, assignments, grades, modules, discussions, quizzes, files, calendar, messaging, and more without manual API token management.4,639 npmMIT
- AlicenseAqualityAmaintenanceRead-only MCP server for Canvas LMS that exposes tools to list courses, assignments, grades, submissions, syllabi, announcements, modules, pages, and files, without any write operations.1130 npm1MIT
- AlicenseNot gradedqualityBmaintenanceA local MCP server that exposes Canvas LMS courses, assignments, grading, discussions, modules, pages, files, messaging, and peer reviews to an AI assistant through about 100 Markdown-returning tools, with preview-then-confirm behavior for any write operations.MIT