Skip to main content
Glama

Codex Canvas MCP

호환 클라이언트가 Canvas를 읽고, 여러 독립적인 안전 검사를 거친 후에만 일반적인 과정 콘텐츠를 작성할 수 있게 해주는 휴대용 로컬 MCP 서버입니다.

안전 모델

  • 로컬 자격 증명 설정 후 기본적으로 Canvas 읽기가 가능합니다.

  • 쓰기는 기본적으로 비활성화되어 있습니다.

  • 모든 콘텐츠 쓰기에는 활성화된 로컬 정책, 과정별 정확한 허용 목록 일치, 정확한 확인 텍스트, 그리고 MCP 클라이언트의 승인이 필요합니다.

  • 이미지 업로드에는 페이로드 게이트가 추가됩니다. 구성된 신뢰 폴더 안에 있는 로컬 소유의 PNG, JPEG 또는 WebP 파일만, 10 MiB 이하만 보낼 수 있습니다.

  • 일반적인 Canvas 쓰기 도구는 없습니다.

  • 자격 증명은 1Password와 선택적으로 macOS Keychain에 유지됩니다. 이 저장소나 클라이언트 구성에 포함되지 않습니다.

모든 콘텐츠 도구는 변경 및 파괴적 작업으로 표시되어 호환 클라이언트가 승인을 요구할 수 있습니다. 로컬 서버는 또한 요청된 작업과 정확히 일치하는 확인 문구가 없으면 호출을 거부합니다. 예: 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

한 과정의 모듈 및 항목 읽기

사용 가능

canvas_read_api

정규화된 Canvas API v1 경로 GET

사용 가능

canvas_get_write_policy

로컬 정책 상태 검사

사용 가능

canvas_upload_image

구성된 신뢰 폴더에서 검증된 이미지 하나 업로드

차단됨

canvas_write_page

페이지 하나 생성 또는 업데이트

차단됨

canvas_create_module

모듈 하나 생성

차단됨

canvas_create_module_item

모듈에 콘텐츠 항목 하나 배치

차단됨

canvas_create_assignment

과제 하나 생성

차단됨

canvas_create_assignment_rubric

Canvas URL에서 과제 루브릭 하나 생성 및 첨부

차단됨

canvas_create_discussion

토론 하나 생성

차단됨

canvas_create_classic_quiz

클래식 퀴즈 하나 생성

차단됨

canvas_create_classic_quiz_question

클래식 퀴즈에 질문 하나 추가

차단됨

canvas_delete_page

페이지 하나 삭제

차단됨

canvas_delete_assignment

과제 하나 삭제

차단됨

canvas_delete_discussion

토론 하나 삭제

차단됨

canvas_delete_classic_quiz

클래식 퀴즈 하나 삭제

차단됨

canvas_delete_module

모듈 하나 및 해당 항목 배치 삭제

차단됨

새 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. 서비스 계정 토큰 전달 방법을 하나 선택합니다:

    • 단기 셸 세션의 경우 로컬 비밀 실행기를 통해 MCP 서버 프로세스에 OP_SERVICE_ACCOUNT_TOKEN을 제공합니다.

    • macOS에서는 해당 토큰을 Keychain에 저장하고 비밀 아닌 조회 레이블을 구성합니다. 예시 명령(안전하게 프롬프트하며 토큰을 명령줄에 넣지 마십시오):

      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 Keychain 서비스 레이블

    CANVAS_KEYCHAIN_ACCOUNT

    OP_SERVICE_ACCOUNT_TOKEN을 사용하지 않을 때의 macOS Keychain 계정 레이블

    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 및 과제 Rubrics, 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