캔버스 MCP 서버

Canvas API와 상호 작용하기 위한 모델 컨텍스트 프로토콜(MCP) 서버입니다. 이 서버를 통해 Canvas 내에서 수업, 과제, 등록 및 성적을 관리할 수 있습니다.

필수 조건

• Node.js : 버전 18 이상

• Canvas API 토큰 : Canvas 계정에서 받으세요

• Canvas 도메인 : 일반적으로 canvas.instructure.com

Related MCP server: Canvas MCP

설정

1. 저장소 복제

   지엑스피1

2. 종속성 설치

   npm install

3. 환경 변수 구성

예제 환경 파일을 복사하세요.

cp .env.example .env

.env를 편집하여 플레이스홀더 값을 실제 Canvas API 토큰과 도메인으로 바꿉니다.

프로젝트 빌드

npm run build

4. 서버 실행

   npm start

   서버가 시작되어 stdio를 통해 MCP 요청을 수신합니다.

Claude Desktop에 연결

1. Claude 구성 업데이트

   claude_desktop_config.json에 MCP 서버 구성을 추가합니다.

  "canvas-mcp-server": {
      "command": "npx",
      "args": ["-y", "canvas-mcp-server"]
    },

Claude Desktop을 다시 시작하세요

Claude Desktop을 완전히 종료하세요. Claude Desktop을 다시 시작하세요. 🔌 메뉴로 이동하여 Canvas MCP 서버를 찾아 연결하세요.

사용 가능한 도구(학생 중심의 추가 자료가 곧 제공될 예정입니다)

• canvas_create_course : Canvas에 새로운 코스를 만듭니다.

• canvas_update_course : Canvas의 기존 과정을 업데이트합니다.

• canvas_create_assignment : Canvas 과정에서 새로운 과제를 만듭니다.

• canvas_update_assignment : 기존 과제를 업데이트합니다.

• canvas_submit_grade : 학생의 과제에 대한 성적을 제출합니다.

• canvas_enroll_user : 사용자를 코스에 등록합니다.

오류 처리

도구는 문제를 나타내기 위해 isError: true 오류 메시지를 반환합니다. 런타임 오류를 방지하려면 모든 필수 환경 변수가 설정되어 있는지 확인하세요.

문제 해결

• 빌드 오류:

TypeScript 버전 확인: npx tsc --version 정리 및 다시 빌드: rm -rf build/ && npm run build

• 런타임 오류:

  자세한 오류 메시지는 로그에서 확인하세요. 환경 변수가 올바르게 설정되었는지 확인하세요.

• 유형 오류:

  TypeScript의 유형 검사를 사용하여 유형을 검증합니다: npx tsc --noEmit

기여하다

기여를 환영합니다! 개선 사항이나 버그 수정 사항이 있으면 이슈를 개설하거나 풀 리퀘스트를 제출해 주세요.

특허

이 프로젝트는 MIT 라이선스에 따라 라이선스가 부여되었습니다.

추가 참고 사항

• 유형 안전성 : types.ts 파일은 Canvas API와의 모든 상호작용이 유형 안전을 보장하여 런타임 오류를 줄이고 코드 유지 관리를 개선합니다.

• 오류 처리 : 서버는 isError 플래그와 함께 의미 있는 메시지를 반환하여 오류를 우아하게 처리하고, 클라이언트(예: Claude Desktop)가 이를 이해하고 적절하게 대응할 수 있도록 합니다.

• 환경 변수 : API 토큰과 같은 민감한 정보는 환경 변수를 통해 관리되므로 다양한 환경에서 보안과 유연성이 향상됩니다.

• 모듈성 : 관심사를 여러 파일( types.ts , client.ts , index.ts )로 분리하면 코드베이스를 탐색하고 유지 관리하기가 더 쉬워집니다.

프로젝트의 특정 요구 사항에 맞게 파일 경로와 구성을 자유롭게 조정하세요. 추가 도움이 필요하시면 알려주세요!