Skip to main content
Glama

Codex Canvas MCP

Ein portabler lokaler MCP-Server, der kompatiblen Clients das Lesen von Canvas und – erst nach mehreren unabhängigen Sicherheitsprüfungen – das Erstellen gängiger Kursinhalte ermöglicht.

Sicherheitsmodell

  • Canvas-Lesezugriffe sind nach der lokalen Einrichtung der Anmeldedaten standardmäßig verfügbar.

  • Schreiben ist standardmäßig deaktiviert.

  • Jeder Inhalts-Schreibvorgang erfordert eine aktivierte lokale Richtlinie, eine exakte Übereinstimmung mit der Whitelist pro Kurs, exakten Bestätigungstext und die Genehmigung im MCP-Client.

  • Der Bild-Upload fügt ein Payload-Gate hinzu: Nur ein lokal gehöriges PNG, JPEG oder WebP in einem konfigurierten vertrauenswürdigen Ordner, nicht größer als 10 MiB, kann gesendet werden.

  • Es gibt kein generisches Canvas-Schreibwerkzeug.

  • Anmeldedaten bleiben in 1Password und optional in der macOS-Schlüsselbund. Sie gehören nicht in dieses Repository oder die Client-Konfiguration.

Jedes Inhaltswerkzeug ist als verändernd und destruktiv markiert, damit kompatible Clients eine Genehmigung verlangen können. Der lokale Server lehnt einen Aufruf auch ab, es sei denn, seine exakte Bestätigung stimmt mit der angeforderten Aktion überein, zum Beispiel APPROVE CANVAS MODULE WRITE course <course_id>.

Die Rubrik-Erstellung akzeptiert eine Canvas-Aufgaben-URL mit gleicher Herkunft, eine URL für ein Modul-Element einer Aufgabe oder eine Kurs-URL mit einem assignment_id-Abfrageparameter. Abfragezeichenfolgen und Fragmente werden ignoriert, nachdem Kurs und Aufgabe aufgelöst wurden. Die URL umgeht niemals die Kursrichtlinie: Ihre Kurs-ID muss weiterhin explizit auf der Whitelist stehen, und die Rubrik-Erstellung erfordert APPROVE CANVAS RUBRIC WRITE course <course_id>. Das Werkzeug weigert sich, eine vorhandene Aufgaben-Rubrik zu ersetzen, verlangt Beschreibungen für jedes Kriterium und jede Bewertung und verlangt, dass die Bewertungsrubrik-Punkte mit den Aufgabenpunkten übereinstimmen.

Related MCP server: canvas-lms

Was enthalten ist

Tool

Fähigkeit

Standard

canvas_get_current_user

Lies das authentifizierte Profil

Verfügbar

canvas_list_modules

Lies Module und Elemente für einen Kurs

Verfügbar

canvas_read_api

GET einen normalisierten Canvas-API-v1-Pfad

Verfügbar

canvas_get_write_policy

Lokalen Richtlinienstatus prüfen

Verfügbar

canvas_upload_image

Ein verifiziertes Bild aus dem konfigurierten vertrauenswürdigen Ordner hochladen

Blockiert

canvas_write_page

Eine Seite erstellen oder aktualisieren

Blockiert

canvas_create_module

Ein Modul erstellen

Blockiert

canvas_create_module_item

Ein Inhaltselement in einem Modul platzieren

Blockiert

canvas_create_assignment

Eine Aufgabe erstellen

Blockiert

canvas_create_assignment_rubric

Eine Aufgaben-Rubrik aus einer Canvas-URL erstellen und anhängen

Blockiert

canvas_create_discussion

Eine Diskussion erstellen

Blockiert

canvas_create_classic_quiz

Ein Classic Quiz erstellen

Blockiert

canvas_create_classic_quiz_question

Eine Frage zu einem Classic Quiz hinzufügen

Blockiert

canvas_delete_page

Eine Seite löschen

Blockiert

canvas_delete_assignment

Eine Aufgabe löschen

Blockiert

canvas_delete_discussion

Eine Diskussion löschen

Blockiert

canvas_delete_classic_quiz

Ein Classic Quiz löschen

Blockiert

canvas_delete_module

Ein Modul und seine Elementplatzierungen löschen

Blockiert

Ein neues Mac einrichten

Voraussetzungen: Python 3.11 oder neuer, die 1Password-CLI, ein 1Password-Dienstkonto, das nur das vorgesehene Canvas-Anmeldedatenelement lesen kann, und ein Canvas-API-Token mit den geringsten für Ihre Arbeit praktikablen Berechtigungen.

  1. Klonen und in eine isolierte Umgebung installieren:

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 .
  1. Erstellen Sie ein 1Password-Element, dessen verborgenes Feld das Canvas-API-Token enthält. Geben Sie dem Dienstkonto nur Lesezugriff auf den enthaltenden Tresor/das enthaltende Element. Notieren Sie den Tresornamen, den Elementnamen oder die Element-ID und die Bezeichnung des verborgenen Feldes; geben Sie deren Werte nicht in dieses Repository.

  2. Wählen Sie eine Zustellmethode für das Dienstkonto-Token:

    • Für eine kurzlebige Shell-Sitzung stellen Sie OP_SERVICE_ACCOUNT_TOKEN über Ihren lokalen Geheimnis-Launcher für den MCP-Serverprozess bereit.

    • Speichern Sie dieses Token unter macOS in der Schlüsselbund und konfigurieren Sie nicht-geheime Suchbezeichnungen. Beispielbefehl (er fragt sicher ab; geben Sie das Token nicht in die Befehlszeile ein):

security add-generic-password -U -s "your-service-label" -a "your-account-label" -w
  1. Konfigurieren Sie den Serverprozess mit diesen nicht-geheimen Werten:

    Variable

    Zweck

    CANVAS_BASE_URL

    Canvas-HTTPS-Ursprung, z. B. https://school.instructure.com

    CANVAS_OP_VAULT

    1Password-Tresorname oder -ID

    CANVAS_OP_ITEM

    Name oder ID des Canvas-Anmeldedatenelements

    CANVAS_OP_FIELD

    Bezeichnung des verborgenen Token-Feldes; Standard ist credential

    CANVAS_KEYCHAIN_SERVICE

    macOS-Schlüsselbund-Dienstbezeichnung, wenn OP_SERVICE_ACCOUNT_TOKEN nicht verwendet wird

    CANVAS_KEYCHAIN_ACCOUNT

    macOS-Schlüsselbund-Kontobezeichnung, wenn OP_SERVICE_ACCOUNT_TOKEN nicht verwendet wird

    CANVAS_IMAGE_UPLOAD_ROOT

    Absoluter Pfad zu dem einzigen lokalen Ordner, aus dem Bild-Upload erlaubt ist

  2. Testen Sie nur die Protokoll- und Sicherheitsgates, ohne Canvas zu kontaktieren oder Anmeldedaten zu lesen:

python -m unittest discover -s tests -v
printf '%s\n' '{"jsonrpc":"2.0","id":1,"method":"tools/list"}' | python -m canvas_mcp
  1. Fügen Sie den stdio-Server zu Codex hinzu. Die Form auf Projektebene ist:

[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"

Fügen Sie dies in die .codex/config.toml des vertrauenswürdigen Projekts oder in Ihre persönliche Codex-Konfiguration ein. Fügen Sie keine geheimen Werte hinzu. Starten Sie neu oder öffnen Sie eine neue Aufgabe, nachdem Sie die MCP-Konfiguration geändert haben, und überprüfen Sie dann die aufgelisteten Werkzeuge, bevor Sie Canvas-Daten anfordern.

ChatGPT-Kompatibilität

Dieses Repository implementiert einen lokalen stdio-MCP-Server für Codex und andere Clients, die lokales stdio-MCP unterstützen. Aktuelle benutzerdefinierte ChatGPT-Apps verbinden sich nicht direkt mit einem lokalen stdio-Server. Die aktuelle Anleitung von OpenAI besteht darin, ein privates lokales MCP über den Secure MCP Tunnel bereitzustellen (oder einen geprüften entfernten MCP-Endpunkt bereitzustellen), abhängig von der Verfügbarkeit des Plans und des Workspace-Administrators. Setzen Sie diesen Prozess nicht direkt dem öffentlichen Internet aus.

Siehe Entwicklermodus und MCP-Apps in ChatGPT, bevor Sie die ChatGPT-Einrichtung versuchen; Verfügbarkeit und Genehmigungsverhalten können sich ändern.

Aktivieren von Inhaltserstellungswerkzeugen

Halten Sie das Schreiben deaktiviert, es sei denn, eine bestimmte Aufgabe erfordert es.

  1. Kopieren Sie config/write-policy.example.json an einen Ort außerhalb des Repositorys.

  2. Fügen Sie nur die genauen Canvas-Kurs-IDs hinzu, die für die Inhaltserstellung genehmigt sind.

  3. Setzen Sie enabled auf true und schränken Sie die Datei ein:

chmod 600 /absolute/private/path/write-policy.json
  1. Fügen Sie CANVAS_WRITE_POLICY=/absolute/private/path/write-policy.json zur MCP-Serverumgebung hinzu.

  2. Starten Sie den Client neu und rufen Sie canvas_get_write_policy auf, um die wirksame Richtlinie zu überprüfen.

  3. Überprüfen Sie bei jedem Inhalts-Schreibvorgang das genaue Ziel und die Nutzlast. Geben Sie den aktionsspezifischen Bestätigungssatz an und genehmigen Sie die verändernde Aktion im Client.

  4. Deaktivieren Sie die Richtlinie erneut, wenn die Aufgabe abgeschlossen ist.

Wenn die Variable fehlt, die Datei fehlt, die Berechtigungen breiter als 0600 sind, das Schreiben deaktiviert ist oder der Kurs nicht auf der Whitelist steht, verweigert der Server den Schreibvorgang.

Aktivieren des Bild-Uploads

Der Bild-Upload verwendet dieselbe lokale Schreibrichtlinie und exakte Kurs-Whitelist sowie CANVAS_IMAGE_UPLOAD_ROOT. Das Werkzeug lehnt relative Pfade, symbolische Links, Dateien außerhalb dieses Stammverzeichnisses, Dateien, die nicht dem aktuellen Benutzer gehören, nicht unterstützte Bildtypen, Dateien, deren binäre Signatur nicht mit der Erweiterung übereinstimmt, und Dateien größer als 10 MiB ab. Die exakte Bestätigung lautet APPROVE CANVAS IMAGE UPLOAD course <course_id>.

Canvas verwendet einen dokumentierten dreistufigen Upload-Austausch: Initialisieren Sie die Kursdatei über die authentifizierte API, senden Sie das Bild ohne das Canvas-Zugriffstoken an die von Canvas zurückgegebene HTTPS-Speicher-URL und authentifizieren Sie den zurückgegebenen Canvas-Abschlussort mit gleicher Herkunft. Das Werkzeug liest dann /api/v1/courses/<course_id>/files/<file_id> und prüft MIME-Typ und Größe, bevor es einen persistenten Kursvorschau-Pfad zurückgibt. Es gibt niemals Speichersignaturen oder die Datei-Download-Verifizierer-URL zurück.

Aktuelle Erstellungsgrenze

Dieses Projekt ist die maßgebliche Quelle für das gemeinsame lokale Canvas-MCP, das von unterstützten Chats auf diesem Mac verwendet wird. Es kann Seiten, Module und Modulelemente, Aufgaben und Aufgaben-Rubriken, Diskussionen und Classic Quizzes mit Fragen nach den üblichen Richtlinien- und Genehmigungsgates erstellen. Es bietet auch ressourcenspezifische Löschwerkzeuge für Seiten, Aufgaben, Diskussionen, Classic Quizzes und Module; das Löschen eines Moduls entfernt seine Elementplatzierungen, aber nicht die zugrunde liegenden Kursinhalte. Seine einzige lokale Dateifähigkeit ist der oben beschriebene, durch Payload-Gate geschützte Bild-Uploader. Generischer Datei-Upload, New Quizzes und Konto-/Kursverwaltung bleiben nicht unterstützt.

Siehe docs/2026-08-06-content-authoring-extension.md für die Implementierung und den End-to-End-Validierungsbericht. Siehe docs/2026-08-16-image-upload-extension.md für das Bedrohungsmodell und den Validierungsbericht zum Bild-Upload.

Entwicklung

python -m pip install -e .
python -m unittest discover -s tests -v
python -m compileall -q src tests

Tests mocken Netzwerk- und Anmeldedatengrenzen. Siehe AGENTS.md für Invarianten, die Mitwirkende bewahren müssen, und ROADMAP.md für absichtlich aufgeschobene administrative Funktionen.

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