课程管理服务器

一个与Teachable API无缝集成的模型上下文协议(MCP)服务器,用于管理课程、用户、注册和进度跟踪。

  • by ahmedrowaihi
  • JavaScript
  • 本地部署
  • 更新于
在 GitHub 查看 ahmedrowaihi/teachable-mcp-server

使用说明

可教MCP服务器

模型上下文协议(MCP)服务器,提供与可访问API的无缝集成。该服务器允许AI助手与您的可教学学校进行交互,管理课程、用户、注册等。

特性

  • 课程管理:列出、查看和管理课程
  • 用户管理:创建、更新和管理用户
  • 注册操作:注册/取消注册课程用户
  • 进度跟踪:监控学生进度和课程完成情况
  • 测验和视频访问:检索测验和视频内容
  • 网钩 管理处理 Webhook 事件
  • 交易跟踪:监控销售和交易
  • 定价计划:管理课程定价

安装

选项1:从NPM安装(推荐)

npm install -g teachable-mcp-server

方案2:地方发展

  1. 克隆或导航到项目目录:

    cd teachable-mcp
    
  2. 安装依赖项:

    npm install
    
  3. 构建TypeScript代码:

    npm run build
    

配置

API密钥设置

MCP服务器需要您的可访问API密钥来验证请求。您有几个选项可以配置它:

选项1:环境文件(.env)

  1. 创建一个 .env 文件在 teachable-mcp 目录:

    cp ../example.env .env
    
  2. 编辑 .env 文件并添加您的API密钥:

    API_KEY_APIKEYAUTH=your_teachable_api_key_here
    

选项2:导出环境变量

export API_KEY_APIKEYAUTH=your_teachable_api_key_here

获取可破解的API密钥

  1. 登录您的Teachable管理仪表板
  2. 引导到 设置 → 集成 → API
  3. 生成或复制现有API密钥
  4. 在环境配置中使用此键

用法

运行MCP服务器

MCP服务器使用 stdio传输,这意味着它通过标准输入/输出流进行通信。这是MCP服务器与AI助手和其他MCP客户端协同工作的标准方式。

直接执行(全局安装)

如果你通过npm全局安装:

# Make sure your API key is set
export API_KEY_APIKEYAUTH=your_teachable_api_key_here

# Run the server
teachable-mcp-server

地方发展

# Make sure your API key is set
export API_KEY_APIKEYAUTH=your_teachable_api_key_here

# Run directly
node build/index.js

# Or use npm script
npm start

服务器将启动并通过stdio传输监听MCP请求。它不打开web服务器或HTTP端点,而是通过stdin/stdout进行通信。

与MCP客户端集成

Claude桌面/光标配置

添加到您的MCP客户端配置中(例如。, claude_desktop_config.json 或类似):

{
  "mcpServers": {
    "teachable": {
      "command": "npx",
      "args": ["-y", "teachable-mcp-server"],
      "env": {
        "API_KEY_APIKEYAUTH": "your_teachable_api_key_here"
      }
    }
  }
}

可用工具

MCP服务器提供以下工具:

课程管理

  • ListCourses -获取你学校的所有课程
  • ShowCourse -按ID获取特定课程
  • ShowCourseEnrollments -获取注册学生和课程进度
  • CourseProgress -获取特定用户的课程进度

内容访问

  • ShowLecture -获取特定课程讲座的内容
  • MarkLectureComplete -将用户的讲座标记为已完成
  • ListQuizzes -获取特定讲座中的测验
  • ShowQuiz -获取特定测验信息
  • ShowQuizResponses -获取测验答案
  • ShowVideo -获取视频信息

用户管理

  • ListUsers -获取用户列表
  • CreateUser -创建新用户
  • ShowUser -获取用户详细信息和注册信息
  • UpdateUser -更新用户信息

注册操作

  • EnrollUser -为用户注册课程
  • UnenrollUser -从课程中取消用户注册

业务运营

  • ListPricingPlans -获取所有定价方案
  • ShowPricingPlans -获取具体的定价计划详细信息
  • ListTransactions -获取销售交易记录

网钩 管理

  • ListWebhooks -获取所有webhook事件
  • ShowWebhookEvents -获取特定webhook的事件

API文档

此MCP服务器是根据可教OpenAPI规范自动生成的。所有工具都直接对应于具有相同参数和响应格式的可撕裂API端点。

有关API的详细文档,请参阅:

安全

  • API密钥:您的可提取API密钥是必需的,并且应保持安全
  • 环境变量:从不将API密钥提交到版本控制
  • 超文本传输安全协议:所有API请求都通过HTTPS发送到 https://developers.teachable.com

从源头构建

# Install dependencies
npm install

# Build TypeScript
npm run build

# Run tests (if available)
npm test

版本

  • 服务器版本: 0.0.1
  • 编译时间时间:2025-08-31T05:18:42.766Z
  • API基本URL: https://developers.teachable.com