canvas-lms-mcp: Instructions file for Codex

AGENTS.md

canvas-lms-mcp AGENTS.md is an instructions file for Codex, OpenCode from bruchris/canvas-lms-mcp. It costs 1,878 tokens per session, scanned A, original, MIT.

A guide for running and contributing to a Canvas LMS MCP server. Canvas LMS is a learning-management system used by schools to manage courses, assignments, grades, and related data.

In plain words
What is it for?
Use it to run the server with `npx` or a global install, configure a Canvas access token and website address, and understand its API, tool, and transport layers.
Why use it?
It gives coding agents the setup commands, required access settings, and project structure needed to work with the server.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: mentions AGENTS.md; mentions Codex.

This is bruchris/canvas-lms-mcp's own configuration. It tells Codex and OpenCode how to work on canvas-lms-mcp itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything canvas-lms-mcp configures →

Reuse

Borrowing it

Nothing to install: this file belongs to bruchris/canvas-lms-mcp. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/bruchris/canvas-lms-mcp/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/bruchris/canvas-lms-mcp

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for canvas-lms-mcp AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/bruchris/canvas-lms-mcp/agents-md/github.svg)](https://agentmods.dev/instructions/bruchris/canvas-lms-mcp/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/bruchris/canvas-lms-mcp/agents-md"><img src="https://agentmods.dev/badge/instructions/bruchris/canvas-lms-mcp/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for canvas-lms-mcp AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/bruchris/canvas-lms-mcp/agents-md"><img src="https://agentmods.dev/badge/instructions/bruchris/canvas-lms-mcp/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,878 This file is loaded in full into every session.
When invoked 1,878 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.01878 $0.01878
Opus 5.5 $0.00751 $0.00751
Sonnet 5.5 $0.00376 $0.00376
Haiku 4.5 $0.00188 $0.00188

Measured 1mo ago against content hash e5dcd34de414, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

canvas-lms-mcp AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 1mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 177 lines

How it starts

The opening of the file, as written. The whole thing — 177 lines — stays where its author put it; the contents beside it link to each section on GitHub.

AGENTS.md — Canvas LMS MCP Server

Guide for AI agents consuming or contributing to canvas-lms-mcp.

Quick Start

# Run with npx (no install needed)
npx canvas-lms-mcp --token $CANVAS_API_TOKEN --base-url https://school.instructure.com

# Or install globally
npm install -g canvas-lms-mcp
canvas-lms-mcp --token $CANVAS_API_TOKEN --base-url $CANVAS_BASE_URL

Environment variables are also supported:

export CANVAS_API_TOKEN=your_token_here
export CANVAS_BASE_URL=https://school.instructure.com
npx canvas-lms-mcp

Architecture

Three-layer design with strict separation of concerns:

Layer 1: src/canvas/       Standalone Canvas REST API client
                           Pure fetch, no MCP dependency, independently importable
                           Modular classes composed into CanvasClient facade

Layer 2: src/tools/        MCP tool definitions
                           Each domain exports (canvas: CanvasClient) => ToolDefinition[]
                           Zod input schemas, annotations, error formatting

Layer 3: src/server.ts     MCP server factory
         src/stdio.ts      stdio transport (Claude Desktop, Cursor, VS Code)
         src/http.ts       HTTP transport: remote_static_token (X-Canvas-Token)
                           or oauth_brokered (MCP OAuth login for Codex/ChatGPT/Claude)
         src/auth/         Auth profiles; src/auth/oauth/ is the OAuth 2.1
                           authorization/resource server + Canvas Developer Key
                           client (docs/oauth-profile.md)
         src/doctor.ts     `canvas-lms-mcp doctor` setup diagnostics

Data Flow

AI Agent  -->  MCP Transport (stdio/HTTP)
                    |
               McpServer (tool dispatch)
                    |
               ToolDefinition.handler (Zod validation + error catch)
                    |
               CanvasClient.module.method (typed API call)
                    |
               CanvasHttpClient (fetch + auth + pagination)
                    |
               Canvas LMS REST API

Read the full file on GitHub · 177 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 1mo ago Changed · +5 lines · +78 tokens per session e5dcd34de414
  2. 1mo ago First seen · 172 lines · 1,800 tokens per session scan A aed982df7931

Subscribe to this mod's changes

canvas-lms-mcp AGENTS.md is an instructions file published in the GitHub repository bruchris/canvas-lms-mcp (10 stars, last pushed yesterday), licensed MIT. It adds 1,878 tokens to every session, about $0.0075 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other instructions, from other repositories