Skip to main content
Glama

Codex Canvas MCP

互換性のあるクライアントがCanvasを読み取り、複数の独立した安全チェックを経た後にのみ一般的なコースコンテンツを作成できる、ポータブルなローカルMCPサーバーです。

安全モデル

  • 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

含まれるもの

ツール

機能

デフォルト

canvas_get_current_user

認証済みプロファイルを読み取る

利用可能

canvas_list_modules

1つのコースのモジュールと項目を読み取る

利用可能

canvas_read_api

正規化されたCanvas API v1パスをGETする

利用可能

canvas_get_write_policy

ローカルポリシーの状態を検査する

利用可能

canvas_upload_image

設定された信頼済みフォルダから検証済み画像を1つアップロードする

ブロック済み

canvas_write_page

1つのページを作成または更新する

ブロック済み

canvas_create_module

1つのモジュールを作成する

ブロック済み

canvas_create_module_item

モジュールに1つのコンテンツ項目を配置する

ブロック済み

canvas_create_assignment

1つの課題を作成する

ブロック済み

canvas_create_assignment_rubric

Canvas URLから1つの課題ルーブリックを作成して添付する

ブロック済み

canvas_create_discussion

1つのディスカッションを作成する

ブロック済み

canvas_create_classic_quiz

1つのクラシッククイズを作成する

ブロック済み

canvas_create_classic_quiz_question

クラシッククイズに1つの質問を追加する

ブロック済み

canvas_delete_page

1つのページを削除する

ブロック済み

canvas_delete_assignment

1つの課題を削除する

ブロック済み

canvas_delete_discussion

1つのディスカッションを削除する

ブロック済み

canvas_delete_classic_quiz

1つのクラシッククイズを削除する

ブロック済み

canvas_delete_module

1つのモジュールとその項目配置を削除する

ブロック済み

新しいMacのセットアップ

前提条件: Python 3.11以降、1Password CLI、意図したCanvas認証情報項目のみを読み取れる1Passwordサービスアカウント、および作業に実用的な最小限の権限を持つCanvas APIトークン。

  1. クローンして分離された環境にインストールします:

    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 .
  2. 隠しフィールドにCanvas APIトークンを含む1Password項目を作成します。サービスアカウントに、含まれるボールト/項目への読み取りアクセスのみを付与します。ボールト名、項目名またはID、隠しフィールドのラベルを記録します。それらの値をこのリポジトリに置かないでください。

  3. サービスアカウントトークンの配信方法を1つ選択します:

    • 短命のシェルセッションの場合、ローカルのシークレットランチャーを通じてMCPサーバープロセスにOP_SERVICE_ACCOUNT_TOKENを提供します。

    • macOSでは、そのトークンをキーチェーンに保存し、非秘密の検索ラベルを設定します。コマンド例(安全にプロンプトが表示されます。トークンをコマンドラインに置かないでください):

      security add-generic-password -U -s "your-service-label" -a "your-account-label" -w
  4. サーバープロセスをこれらの非秘密の値で設定します:

    変数

    目的

    CANVAS_BASE_URL

    Canvas HTTPSオリジン。例: https://school.instructure.com

    CANVAS_OP_VAULT

    1Passwordボールト名またはID

    CANVAS_OP_ITEM

    Canvas認証情報項目名またはID

    CANVAS_OP_FIELD

    隠しトークンフィールドのラベル。デフォルトはcredential

    CANVAS_KEYCHAIN_SERVICE

    OP_SERVICE_ACCOUNT_TOKENを使用しない場合のmacOSキーチェーンサービスラベル

    CANVAS_KEYCHAIN_ACCOUNT

    OP_SERVICE_ACCOUNT_TOKENを使用しない場合のmacOSキーチェーンアカウントラベル

    CANVAS_IMAGE_UPLOAD_ROOT

    画像アップロードが許可される唯一のローカルフォルダへの絶対パス

  5. Canvasに接続したり認証情報を読み取ったりせずに、プロトコルとセキュリティゲートのみをテストします:

    python -m unittest discover -s tests -v
    printf '%s\n' '{"jsonrpc":"2.0","id":1,"method":"tools/list"}' | python -m canvas_mcp
  6. 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アプリを参照してください。可用性と承認の動作は変更される可能性があります。

コンテンツ作成ツールの有効化

特定のタスクで必要でない限り、書き込みをオフにしておいてください。

  1. config/write-policy.example.jsonをリポジトリ外の場所にコピーします。

  2. コンテンツ作成が承認された正確なCanvasコースIDのみを追加します。

  3. enabledをtrueに設定し、ファイルを制限します:

    chmod 600 /absolute/private/path/write-policy.json
  4. MCPサーバー環境にCANVAS_WRITE_POLICY=/absolute/private/path/write-policy.jsonを追加します。

  5. クライアントを再起動し、canvas_get_write_policyを呼び出して有効なポリシーを確認します。

  6. 各コンテンツ書き込みについて、正確なターゲットとペイロードを確認します。アクション固有の確認フレーズを提供し、クライアントで変更アクションを承認します。

  7. タスクが完了したら、ポリシーを再度無効にします。

変数が存在しない、ファイルが存在しない、権限が0600より広い、書き込みが無効、またはコースが許可リストにない場合、サーバーは書き込みを拒否します。

画像アップロードの有効化

画像アップロードは、同じローカル書き込みポリシーと正確なコース許可リストに加えて、CANVAS_IMAGE_UPLOAD_ROOTを使用します。このツールは、相対パス、シンボリックリンク、そのルート外のファイル、現在のユーザーが所有していないファイル、サポートされていない画像タイプ、拡張子とバイナリ署名が一致しないファイル、および10 MiBを超えるファイルを拒否します。正確な確認はAPPROVE CANVAS IMAGE UPLOAD course <course_id>です。

Canvasは文書化された3段階のアップロード交換を使用します: 認証済みAPIを通じてコースファイルを初期化し、Canvasアクセストークンなしで画像をCanvasの返されたHTTPSストレージURLに送信し、返された同一オリジンのCanvas完了場所を認証します。その後、ツールは/api/v1/courses/<course_id>/files/<file_id>を読み取り、MIMEタイプとサイズをチェックしてから、永続的なコースプレビューパスを返します。ストレージ署名やファイルダウンロード検証URLを返すことはありません。

現在の作成境界

このプロジェクトは、このMac上のサポートされているチャットで使用される共有ローカルCanvas MCPのソースオブジェクトトゥルースです。通常のポリシーと承認ゲートを通過した後、Pages、Modulesとモジュール項目、Assignmentsと課題ルーブリック、Discussions、および質問付きのClassic Quizzesを作成できます。また、Pages、Assignments、Discussions、Classic Quizzes、Modules用のリソース固有の削除ツールも提供します。Moduleを削除すると、その項目配置は削除されますが、基になるコースコンテンツは削除されません。その唯一のローカルファイル機能は、上記のペイロードゲート付き画像アップローダーです。汎用ファイルアップロード、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 tools
canvas_create_assignmentA
Destructive

Create exactly one Canvas assignment in an approved course. Disabled by default and requires explicit confirmation.

NameRequiredDescriptionDefault
nameYes
course_idYes
publishedNo
descriptionNo
confirmationYes
points_possibleNo
submission_typesNo

TDQS

A3.7/5.0
Behavior4/5

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.

Conciseness5/5

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.

Completeness2/5

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.

Parameters2/5

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.

Purpose5/5

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.

Usage Guidelines3/5

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_quizA
Destructive

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.

NameRequiredDescriptionDefault
titleYes
course_idYes
publishedNo
quiz_typeNopractice_quiz
descriptionNo
confirmationYes

TDQS

A4.1/5.0
Behavior4/5

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.

Conciseness5/5

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.

Completeness4/5

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.

Parameters2/5

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.

Purpose5/5

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.

Usage Guidelines4/5

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_questionA
Destructive

Add one question to an existing Canvas Classic Quiz in an approved course. Disabled by default and requires explicit confirmation.

NameRequiredDescriptionDefault
answersNo
quiz_idYes
course_idYes
confirmationYes
question_nameYes
question_textYes
question_typeYes
points_possibleNo

TDQS

A3.9/5.0
Behavior4/5

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.

Conciseness5/5

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.

Completeness2/5

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.

Parameters2/5

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.

Purpose5/5

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.

Usage Guidelines4/5

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_discussionA
Destructive

Create exactly one Canvas discussion in an approved course. Disabled by default and requires explicit confirmation.

NameRequiredDescriptionDefault
titleYes
messageYes
course_idYes
publishedNo
confirmationYes
discussion_typeNothreaded

TDQS

A4/5.0
Behavior4/5

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.

Conciseness5/5

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.

Completeness3/5

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.

Parameters2/5

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.

Purpose5/5

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.

Usage Guidelines4/5

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_moduleA
Destructive

Create exactly one Canvas module in an approved course. Disabled by default and requires explicit confirmation.

NameRequiredDescriptionDefault
nameYes
positionNo
course_idYes
publishedNo
confirmationYes

TDQS

A3.7/5.0
Behavior4/5

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.

Conciseness5/5

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.

Completeness2/5

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.

Parameters1/5

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.

Purpose5/5

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.

Usage Guidelines4/5

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_itemA
Destructive

Add one existing Canvas content item or external URL to an existing module in an approved course. Disabled by default and requires explicit confirmation.

NameRequiredDescriptionDefault
typeYes
titleYes
new_tabNo
page_urlNo
positionNo
course_idYes
module_idYes
content_idNo
confirmationYes
external_urlNo

TDQS

A3.8/5.0
Behavior4/5

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.

Conciseness5/5

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.

Completeness2/5

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.

Parameters3/5

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.

Purpose5/5

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.

Usage Guidelines3/5

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_userA
Read-only

Read the authenticated Canvas user's profile. Read-only.

NameRequiredDescriptionDefault

No parameters

TDQS

A4/5.0
Behavior3/5

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.

Conciseness5/5

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.

Completeness4/5

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.

Parameters4/5

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.

Purpose5/5

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.

Usage Guidelines3/5

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_policyA
Read-only

Show write-policy state and approved course IDs. Does not expose credentials.

NameRequiredDescriptionDefault

No parameters

TDQS

A4.1/5.0
Behavior4/5

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.

Conciseness5/5

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.

Completeness5/5

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.

Parameters4/5

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.

Purpose5/5

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.

Usage Guidelines2/5

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_modulesA
Read-only

List modules and module items for one Canvas course. Read-only.

NameRequiredDescriptionDefault
course_idYes

TDQS

A3.8/5.0
Behavior3/5

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.

Conciseness5/5

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.

Completeness4/5

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.

Parameters3/5

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.

Purpose5/5

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.

Usage Guidelines3/5

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_apiB
Read-only

Read one Canvas REST API v1 path with GET. Cannot make changes.

NameRequiredDescriptionDefault
pathYes
queryNo

TDQS

B3.4/5.0
Behavior3/5

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.

Conciseness5/5

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.

Completeness3/5

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.

Parameters2/5

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.

Purpose5/5

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.

Usage Guidelines2/5

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_pageA
Destructive

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.

NameRequiredDescriptionDefault
bodyYes
titleYes
page_urlNoExisting Canvas page URL slug. Omit to create a page.
course_idYes
publishedNo
confirmationYes

TDQS

A4.1/5.0
Behavior4/5

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.

Conciseness5/5

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.

Completeness4/5

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.

Parameters2/5

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.

Purpose5/5

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.

Usage Guidelines4/5

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.

  1. 11 tool updatesv0.2.0
    • First observedcanvas_create_assignment
    • First observedcanvas_create_classic_quiz
    • First observedcanvas_create_classic_quiz_question
    • First observedcanvas_create_discussion
    • First observedcanvas_create_module
    • First observedcanvas_create_module_item
    • First observedcanvas_get_current_user
    • First observedcanvas_get_write_policy
    • First observedcanvas_list_modules
    • First observedcanvas_read_api
    • First observedcanvas_write_page

TDQS

A3.9/5.0

Scored across 11 tools

Disambiguation5/5

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.

Naming Consistency4/5

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.

Tool Count5/5

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.

Completeness3/5

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

ActivityActive
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers