界面已本地化;技能介绍与说明文档按所选语言由 AI 自动翻译,代码、命令、路径和专业术语保留原文,以原作者文档为准。
探索技能
开发与工程 · SKILL.md

openedx-mcp-connector

openedx-mcp-connector

【开发与工程】MCP connector for Open edX – enables AI-powered online course creation, XBlock development, and learner engagement management through Claude

独立 GitHub 快照 · 自动分类 · 以原作者文档为准

技能说明

GitHub

name: openedx-mcp-connector description: "MCP connector for Open edX – enables AI-powered online course creation, XBlock development, and learner engagement management through Claude" license: AGPL tags: ["education","lms","mcp","openedx","mooc"] difficulty: advanced time_to_master: "4-8 weeks" version: "1.0.0"

Openedx MCP Connector

Overview

This skill enables Claude to interact with Openedx through the Model Context Protocol (MCP). It provides a bridge between Claude's AI capabilities and Openedx's REST API, allowing natural language control of Openedx operations, intelligent automation, and AI-powered assistance for Openedx workflows.

When to Use This Skill

  • Course outline and section creation
  • XBlock content generation and configuration
  • Learner engagement analytics and reporting
  • Grading policy configuration
  • Certificate and credential management

Architecture

┌─────────────┐     ┌─────────────────┐     ┌──────────────────┐
│   Claude     │────▶│   MCP Server    │────▶│   Openedx          │
│   (Client)   │◀────│   (TypeScript)  │◀────│   (REST API      )│
└─────────────┘     └─────────────────┘     └──────────────────┘

Core Concepts

MCP Server Setup

The connector implements an MCP server that exposes Openedx operations as tools Claude can invoke. The server translates natural language intentions into REST API calls.

Key Endpoints/Interfaces

/api/courses/v1/courses, /api/enrollment/v1/enrollment, /api/grades/v1/grades, /api/user/v1/accounts

Implementation

// Openedx MCP Server Implementation
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
import { z } from "zod";

const server = new McpServer({
  name: "openedx-mcp-connector",
  version: "1.0.0",
});

// Tool: List/Query Resources
server.tool(
  "list_resources",
  "List and query Openedx resources with optional filters",
  {
    query: z.string().optional().describe("Search query or filter"),
    limit: z.number().optional().describe("Max results to return"),
  },
  async ({ query, limit }) => {
    // Call Openedx REST API
    const response = await fetch(`${BASE_URL}/api/courses/v1/courses`, {
      headers: { "Authorization": `Bearer ${API_KEY}` },
    });
    const data = await response.json();
    return {
      content: [{ type: "text", text: JSON.stringify(data, null, 2) }],
    };
  }
);

// Tool: Create Resource
server.tool(
  "create_resource",
  "Create a new resource in Openedx",
  {
    name: z.string().describe("Resource name"),
    config: z.object({}).passthrough().optional().describe("Resource configuration"),
  },
  async ({ name, config }) => {
    const response = await fetch(`${BASE_URL}/api/courses/v1/courses`, {
      method: "POST",
      headers: {
        "Authorization": `Bearer ${API_KEY}`,
        "Content-Type": "application/json",
      },
      body: JSON.stringify({ name, ...config }),
    });
    const data = await response.json();
    return {
      content: [{ type: "text", text: `Created: ${JSON.stringify(data)}` }],
    };
  }
);

// Tool: Analyze/Report
server.tool(
  "analyze",
  "AI-powered analysis of Openedx data",
  {
    type: z.string().describe("Analysis type"),
    timeframe: z.string().optional().describe("Time range for analysis"),
  },
  async ({ type, timeframe }) => {
    // Fetch data and provide AI analysis
    const response = await fetch(`${BASE_URL}/api/courses/v1/courses`, {
      headers: { "Authorization": `Bearer ${API_KEY}` },
    });
    const data = await response.json();
    return {
      content: [{ type: "text", text: JSON.stringify(data, null, 2) }],
    };
  }
);

// Start server
const transport = new StdioServerTransport();
await server.connect(transport);

Claude Desktop Configuration

{
  "mcpServers": {
    "openedx-mcp-connector": {
      "command": "node",
      "args": ["path/to/openedx-mcp-connector/index.js"],
      "env": {
        "OPENEDX_API_KEY": "your-api-key",
        "OPENEDX_BASE_URL": "https://your-instance-url"
      }
    }
  }
}

Best Practices

  1. Authentication: Store API keys securely using environment variables; never hardcode credentials
  2. Rate Limiting: Implement request throttling to respect Openedx API rate limits
  3. Error Handling: Provide clear, actionable error messages for common failure scenarios
  4. Pagination: Handle paginated responses for large datasets efficiently
  5. Caching: Cache frequently accessed read-only data to reduce API calls
  6. Security: Validate all inputs before passing to the Openedx API; sanitize outputs
  7. Logging: Log all API interactions for debugging and audit purposes

Example Prompts

"Design a 6-week course outline on Python programming with weekly assessments and a final project"

Security Considerations

  • All API credentials must be stored as environment variables
  • Implement input validation and sanitization for all tool parameters
  • Use HTTPS for all API communications
  • Follow the principle of least privilege for API token permissions
  • Audit log all write operations for compliance tracking

Resources

Changelog

VersionDateChanges
1.0.02026-04-01Initial MCP connector skill

Part of SkillGalaxy - 10,000+ comprehensive skills for AI-assisted development.

我的收藏