Skip to main content
Glama

OA-Y MCP Service

MCP for managing courses via HTTP API at oa-y.com.


Integration as MCP Server

This service supports two transport protocols for MCP integration: STDIO and StreamableHTTP.

Mode 1: STDIO (Local/Command Line)

For local integration with Cursor, Claude Desktop, or other MCP clients:

{
  "mcpServers": {
    "oa-y-mcp-service": {
      "command": "npx",
      "args": ["-y", "github:AdminRHS/oa-y-mcp-service"],
      "env": {
        "APP_ENV": "prod",
        "API_TOKEN": "your_token",
        "API_TOKEN_LIBS": "your_libs_token"
      }
    }
  }
}

Mode 2: StreamableHTTP (Remote/HTTP)

For remote integration via StreamableHTTP:

{
  "mcpServers": {
    "oa-y-remote": {
      "url": "http://your-server:3000/mcp?API_TOKEN=your_token&API_TOKEN_LIBS=your_libs_token&APP_ENV=prod"
    }
  }
}

When to use each transport:

  • STDIO (stdin/stdout, Desktop‑first): Ideal for Desktop apps and local IDE integrations (Cursor, Claude Desktop).

  • StreamableHTTP (/mcp, Browser/Agents‑first): Best for AI agents and browser/cloud clients (including proxies/tunnels).

API_TOKEN

How to get your API_TOKEN:

  1. Go to https://oa-y.com and log in as an admin.

  2. Open the Admin Panel and go to the API Tokens tab.

  3. Click Create Token, enter a name, and create the token.

  4. Copy the generated token and use it as the API_TOKEN environment variable.

API_TOKEN_LIBS

How to get your API_TOKEN_LIBS:

  1. Go to https://libs.anyemp.com and log in as an admin.

  2. Open the Admin Panel and go to the API Tokens tab.

  3. Click Create Token, enter a name (e.g., "Libs API"), and create the token.

  4. Copy the generated token and use it as the API_TOKEN_LIBS environment variable.

APP_ENV

Environment setting:

  • prod - Production environment (default, uses oa-y.com and libs.anyemp.com)

  • dev - Development/testing (uses lrn.oa-y.com and libdev.anyemp.com)


Related MCP server: canvas-lms

Available MCP Tools

This section describes all available tools for managing courses, lessons, modules, tests, and professions.

Course Management

  • get_courses — get a list of courses (with filters and pagination, supports profession filtering)

  • get_course — get a course by id

  • create_course — create a course (requires module IDs from create_module)

  • update_course — update a course (requires module IDs from create_module)

Lesson Management

  • get_lessons — get a list of lessons

  • get_lesson — get a lesson by id

  • create_lesson — create a lesson (use this first to get lesson IDs)

  • update_lesson — update a lesson

Module Management

  • get_modules — get a list of modules

  • get_module — get a module by id

  • create_module — create a module (requires lesson IDs from create_lesson)

  • update_module — update a module (requires lesson IDs from create_lesson)

Test Management

  • get_tests — get a list of tests

  • get_test — get a test by id

  • create_test — create a test (requires lesson ID from create_lesson, tests are attached to lessons)

  • update_test — update a test (requires lesson ID from create_lesson, tests are attached to lessons)

Profession Management

  • get_professions — get all professions (returns array with name and ID)

  • get_skills — get all skills (returns array with name and ID)

  • get_tools — get all tools (returns array with name and ID)

Creation Order

IMPORTANT: Follow the correct sequential creation order for courses, modules, lessons, and tests.

Sequential workflow:

  1. CREATE COURSE:

    • Use create_course to create the course structure

    • Can start with empty modules array, will be updated later

  2. CREATE MODULE (at least one module required):

    • Use create_module to create a module

    • Can start with empty lessons array

    • Get module ID from the response

  3. CREATE FIRST LESSON (at least one lesson per module required):

    • Use create_lesson to create a lesson

    • Get lesson ID from the response

  4. CREATE TEST FOR LESSON (optional):

    • Use create_test with the lesson ID to attach test to this lesson

    • IMPORTANT: Tests are attached to lessons, not modules

    • Get test ID from the response

  5. UPDATE LESSON WITH TEST (if test was created):

    • Use update_lesson to add test IDs to the lesson's tests array

  6. CREATE NEXT LESSON (repeat steps 3-5):

    • Create another lesson for the same module

    • Create tests for it

    • Update lesson with test IDs

    • Repeat until all lessons for this module are created

  7. UPDATE MODULE WITH ALL LESSON IDS:

    • Use update_module to add all created lesson IDs to the module

    • Example: lessons: ["lesson_id_1", "lesson_id_2", "lesson_id_3"]

  8. CREATE NEXT MODULE (repeat steps 2-7):

    • Create next module

    • Create lessons for it

    • Create tests for lessons

    • Update lessons and module

    • Repeat until all modules are created

  9. UPDATE COURSE WITH ALL MODULE IDS:

    • Use update_course to add all module IDs with their order

    • Example: modules: [{ module: "module_id_1", order: 1 }, { module: "module_id_2", order: 2 }]

Required structure:

  • Course must contain at least one module

  • Module must contain at least one lesson

  • Tests are optional but attached to lessons (not modules)

  • Each module has ordered lessons

  • Each course has ordered modules

Data flow:

Course
  └─ Module 1 (order: 1)
      ├─ Lesson 1
      │   └─ Test 1 (optional)
      ├─ Lesson 2
      │   └─ Test 2 (optional)
      └─ ...
  └─ Module 2 (order: 2)
      ├─ Lesson 1
      └─ ...

Example Requests

Get Courses:

{
  "name": "get_courses",
  "arguments": { "page": 1, "limit": 10 }
}

Get Courses by Professions:

{
  "name": "get_courses",
  "arguments": {
    "professions": [68, 69],
    "difficulty": "beginner"
  }
}

Create Lesson (first):

{
  "name": "create_lesson",
  "arguments": {
    "title": "Lesson Title",
    "description": "Lesson description (optional)",
    "type": "text",
    "contentType": "standard",
    "content": "Lesson content here",
    "image": "https://example.com/lesson-image.jpg",
    "duration": 30,
    "professions": [],
    "skills": [],
    "tests": []
  }
}

Create Module (with lesson IDs):

{
  "name": "create_module",
  "arguments": {
    "title": "Module Title",
    "content": "Module description (plain text)",
    "description": "Optional detailed description",
    "videoUrl": "https://example.com/video.mp4",
    "previewImage": "https://example.com/preview.jpg",
    "lessons": ["lesson_id_from_create_lesson"]
  }
}

Note: Modules don't contain tests directly. Tests are attached to lessons.

Create Course (with module IDs):

{
  "name": "create_course",
  "arguments": {
    "title": "Course Title",
    "description": "Course description",
    "difficulty": "beginner",
    "modules": [
      {
        "module": "module_id_from_create_module",
        "order": 1
      }
    ],
    "professions": [],
    "image": "",
    "duration": 60
  }
}

Get Professions:

{
  "name": "get_professions",
  "arguments": {}
}

Get Skills:

{
  "name": "get_skills",
  "arguments": {}
}

Get Tools:

{
  "name": "get_tools",
  "arguments": {}
}

Create Test (with lesson ID):

{
  "name": "create_test",
  "arguments": {
    "title": "Test Title",
    "description": "Test description",
    "lesson": "lesson_id_from_create_lesson",
    "questions": [
      {
        "question": "What is HTML?",
        "type": "single-choice",
        "options": [
          { "text": "HyperText Markup Language", "isCorrect": true },
          { "text": "High Tech Modern Language", "isCorrect": false }
        ],
        "points": 10
      }
    ],
    "passingScore": 70,
    "timeLimit": 30
  }
}

IMPORTANT: Tests are attached to lessons, not modules. Use lesson ID from create_lesson.

Update Course (with module IDs):

{
  "name": "update_course",
  "arguments": {
    "courseId": "course_id_here",
    "title": "Updated Course Title",
    "description": "Updated course description",
    "difficulty": "intermediate",
    "modules": [
      {
        "module": "existing_module_id",
        "order": 1
      },
      {
        "module": "new_module_id_from_create_module",
        "order": 2
      }
    ]
  }
}

Course Filtering by Professions

The get_courses tool supports filtering courses by profession IDs:

Workflow:

  1. Call get_professions to get all available professions with their IDs

  2. Use profession IDs in get_courses with the professions parameter

Parameters:

  • professions - Array of profession IDs (numbers)

  • difficulty - Filter by difficulty: "beginner", "intermediate", "advanced"

  • search - Search by course name or description

  • page - Page number for pagination

  • limit - Number of courses per page

  • all - Get all courses without pagination


Testing

This section describes how to test the MCP service in different modes.

Testing Mode 1: STDIO (Local/Command Line)

Prerequisites:

Steps:

  1. Install dependencies:

    npm install
  2. Build the bundled version:

    npm run build

    This creates oa-y-mcp-service.cjs file that will be used by MCP clients.

  3. Configure your MCP client (Cursor/Claude Desktop):

    Add to your MCP settings file:

    {
      "mcpServers": {
        "oa-y-local": {
          "command": "node",
          "args": ["c:/Projects/RH/oa-y-mcp-service/oa-y-mcp-service.cjs"],
          "env": {
            "APP_ENV": "prod",
            "API_TOKEN": "your_token",
            "API_TOKEN_LIBS": "your_libs_token"
          }
        }
      }
    }
  4. Restart your MCP client (Cursor/Claude Desktop)

  5. Test the tools:

    • Try calling get_professions to verify connection

    • Try creating a lesson with create_lesson

    • Verify that all tools are available and working

For development/debugging:

npm run dev          # Run in STDIO mode
npm run dev:inspect  # Run with Node Inspector

Testing Mode 2: StreamableHTTP (Remote/HTTP)

Prerequisites:

Steps:

  1. Install dependencies:

    npm install
  2. Start the HTTP server:

    npm start
    # or
    npm run http
  3. Test health endpoint:

    curl http://localhost:3000/health
  4. Configure your MCP client (Cursor/Claude Desktop):

    Add to your MCP settings file:

    {
      "mcpServers": {
        "oa-y-http": {
          "url": "http://localhost:3000/mcp?API_TOKEN=your_token&API_TOKEN_LIBS=your_libs_token&APP_ENV=prod"
        }
      }
    }
  5. Restart your MCP client (Cursor/Claude Desktop)

  6. Test the tools:

    • Try calling get_professions to verify connection

    • Try creating a lesson with create_lesson

    • Verify that all tools are available and working

For development/debugging:

npm run http:inspect  # Run HTTP server with Node Inspector

Available HTTP endpoints:

  • GET /mcp — StreamableHTTP handshake/stream

  • POST /mcp — MCP protocol endpoint

  • GET /health — health check

  • GET / — service information

Testing with public URL (localtunnel):

For testing with remote access:

  1. Install localtunnel:

    npm install -g localtunnel
  2. Start your local server:

    npm start
  3. Create a public tunnel:

    lt --port 3000 --local-host localhost
  4. Use the provided URL in your MCP client:

    {
      "mcpServers": {
        "oa-y-remote": {
          "url": "https://random-subdomain.loca.lt/mcp?API_TOKEN=your_token&API_TOKEN_LIBS=your_libs_token&APP_ENV=prod"
        }
      }
    }

Deployment

This section describes how to deploy the MCP service for production use.

Deployment Mode 1: STDIO (NPM Package via GitHub)

This mode allows users to install your MCP service directly from GitHub using npx.

Requirements:

  • Repository pushed to GitHub

  • Built oa-y-mcp-service.cjs file committed to repository

Deployment Steps:

  1. Build the bundled version:

    npm run build

    This creates oa-y-mcp-service.cjs — the bundled file that includes all dependencies.

  2. Commit and push to GitHub:

    git add oa-y-mcp-service.cjs
    git commit -m "Build MCP service for distribution"
    git push origin main
  3. Users can now install via npx:

    {
      "mcpServers": {
        "oa-y-mcp-service": {
          "command": "npx",
          "args": ["github:AdminRHS/oa-y-mcp-service"],
          "env": {
            "APP_ENV": "prod",
            "API_TOKEN": "user_token",
            "API_TOKEN_LIBS": "user_libs_token"
          }
        }
      }
    }

Important:

  • Always build before pushing: npm run build

  • The built file oa-y-mcp-service.cjs must be committed to the repository

  • Users will download and run this file via npx

Deployment Mode 2: StreamableHTTP (Docker on Server)

This mode deploys the MCP service as an HTTP server using Docker.

Requirements:

  • Docker and Docker Compose installed on server

  • Server with public IP or domain name

Deployment Steps:

  1. On your server, clone the repository:

    git clone https://github.com/AdminRHS/oa-y-mcp-service.git
    cd oa-y-mcp-service
  2. Create .env file (optional, for custom port):

    PORT=3000
  3. Start the service with Docker Compose:

    docker-compose up -d
  4. Verify the service is running:

    curl http://localhost:3000/health
  5. Users can now connect via HTTP:

    {
      "mcpServers": {
        "oa-y-remote": {
          "url": "http://your-server-ip:3000/mcp?API_TOKEN=user_token&API_TOKEN_LIBS=user_libs_token&APP_ENV=prod"
        }
      }
    }

Docker Compose Configuration:

The service uses docker-compose.yml and Dockerfile:

  • Builds image from Node.js Alpine

  • Installs dependencies

  • Exposes port 3000 (configurable via .env)

  • Auto-restarts on failure

Updating the Deployment:

To update the service on the server:

git pull origin main
docker-compose down
docker-compose up -d --build

Monitoring:

View logs:

docker-compose logs -f

Check container status:

docker-compose ps

Production Recommendations:

  • Use a reverse proxy (nginx/traefik) for HTTPS

  • Set up proper firewall rules

  • Use environment-specific API tokens

  • Configure monitoring and alerts

  • Set up automated backups


Response Format

All responses follow the MCP (Model Context Protocol) JSON-RPC 2.0 format. See MCP documentation for details.


Available Scripts

  • npm run dev - Run STDIO mode (local development)

  • npm run dev:inspect - Run STDIO mode with Inspector

  • npm run http - Run HTTP server mode

  • npm run http:inspect - Run HTTP server with Inspector

  • npm start - Start HTTP server (default)

  • npm run build - Build bundled version (oa-y-mcp-service.cjs)

Available Tools

19 tools
create_courseD
ParametersJSON Schema
NameRequiredDescriptionDefault
imageNoPath to course image (optional, default standard image)
titleYesCourse title (required, automatically generates slug)
toolsNoArray of tool IDs from libraries service (optional, can be empty array)
videosNoArray of video URLs (optional)
isDraftNoIs draft (optional, default: true)
modulesNoCourse modules with lesson IDs (create lessons first, then add their IDs to modules)
difficultyYesDifficulty level (required)
descriptionYesCourse description (required)
professionsNoArray of profession IDs from microservice (optional, can be empty array)

TDQS

D1/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Tool has no description.

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?

Tool has no description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tool has no description.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Tool has no description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

create_lessonD
ParametersJSON Schema
NameRequiredDescriptionDefault
typeYesLesson type (optional)
imageNoLesson image URL (optional)
titleYesLesson title (required, automatically generates slug)
skillsNoArray of skill IDs from libservice (optional, can be empty array)
contentNoMain lesson content (HTML/Markdown, required if contentType !== "mixed")
isDraftNoIs draft (optional, default: true)
durationNoLesson duration in minutes (optional, default: 0)
videoUrlNoVideo URL (for video type lessons)
resourcesNoAdditional resources
contentTypeYesContent type (optional)
descriptionNoLesson description (optional)
professionsNoArray of profession IDs from libservice (optional, can be empty array)
contentBlocksNoContent blocks (required if contentType === "mixed")
practiceExercisesNoPractice exercises

TDQS

D1/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Tool has no description.

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?

Tool has no description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tool has no description.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Tool has no description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

create_moduleD
ParametersJSON Schema
NameRequiredDescriptionDefault
titleYesModule title (required, automatically generates slug)
contentYesModule description (required, plain text)
isDraftNoIs draft (optional, default: true)
lessonsNoArray of lesson IDs (can be empty array)
videoUrlNoVideo URL for module (optional)
descriptionNoModule description (optional)
previewImageNoPreview image URL (optional)

TDQS

D1/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Tool has no description.

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?

Tool has no description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tool has no description.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Tool has no description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

create_testD
ParametersJSON Schema
NameRequiredDescriptionDefault
titleYesTest title (required, automatically generates slug)
lessonYesLesson ID (required)
questionsYesArray of test questions
timeLimitNoTime limit in minutes (optional)
descriptionNoTest description (optional)
passingScoreNoMinimum score to pass (0-100)

TDQS

D1/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Tool has no description.

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?

Tool has no description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tool has no description.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Tool has no description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_courseD
ParametersJSON Schema
NameRequiredDescriptionDefault
courseIdYesCourse ID

TDQS

D1/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Tool has no description.

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?

Tool has no description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tool has no description.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Tool has no description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_coursesD
ParametersJSON Schema
NameRequiredDescriptionDefault
allNoGet all courses without pagination
pageNoPage number (default: 1)
limitNoNumber of courses per page (default: 10)
searchNoSearch by course name or description
difficultyNoFilter by difficulty level
professionsNoArray of profession IDs to filter courses (must be obtained via get_professions tool call)

TDQS

D1/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Tool has no description.

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?

Tool has no description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tool has no description.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Tool has no description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_lessonD
ParametersJSON Schema
NameRequiredDescriptionDefault
courseIdYesCourse ID
lessonIdYesLesson ID
moduleIdYesModule ID

TDQS

D1/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Tool has no description.

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?

Tool has no description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tool has no description.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Tool has no description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_lessonsD
ParametersJSON Schema
NameRequiredDescriptionDefault
allNoGet all lessons without pagination
pageNoPage number (default: 1)
typeNoFilter by lesson type
limitNoNumber of lessons per page (default: 10)
searchNoSearch by lesson title or description
contentTypeNoFilter by content type
professionsNoArray of profession IDs to filter lessons (must be obtained via get_professions tool call)

TDQS

D1/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Tool has no description.

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?

Tool has no description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tool has no description.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Tool has no description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_moduleD
ParametersJSON Schema
NameRequiredDescriptionDefault
moduleIdYesModule ID

TDQS

D1/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Tool has no description.

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?

Tool has no description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tool has no description.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Tool has no description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_modulesD
ParametersJSON Schema
NameRequiredDescriptionDefault
pageNoPage number (default: 1)
limitNoNumber of modules per page (default: 10)
searchNoSearch by module title or description

TDQS

D1/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Tool has no description.

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?

Tool has no description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tool has no description.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Tool has no description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_professionsD
ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

D1/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Tool has no description.

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?

Tool has no description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tool has no description.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Tool has no description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_skillsD
ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

D1/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Tool has no description.

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?

Tool has no description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tool has no description.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Tool has no description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_testD
ParametersJSON Schema
NameRequiredDescriptionDefault
testIdYesTest ID

TDQS

D1/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Tool has no description.

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?

Tool has no description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tool has no description.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Tool has no description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_testsD
ParametersJSON Schema
NameRequiredDescriptionDefault
pageNoPage number (default: 1)
limitNoNumber of tests per page (default: 10)
searchNoSearch by test title or description

TDQS

D1/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Tool has no description.

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?

Tool has no description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tool has no description.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Tool has no description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_toolsD
ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

D1/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Tool has no description.

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?

Tool has no description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tool has no description.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Tool has no description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

update_courseD
ParametersJSON Schema
NameRequiredDescriptionDefault
imageNoPath to course image (optional, default standard image)
titleYesCourse title (required, automatically generates slug)
toolsNoArray of tool IDs from libraries service (optional, can be empty array)
videosNoArray of video URLs (optional)
isDraftNoIs draft (optional, default: true)
modulesNoCourse modules with lesson IDs (create lessons first, then add their IDs to modules)
courseIdYesCourse ID for update
difficultyYesDifficulty level (required)
descriptionYesCourse description (required)
professionsNoArray of profession IDs from microservice (optional, can be empty array)

TDQS

D1/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Tool has no description.

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?

Tool has no description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tool has no description.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Tool has no description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

update_lessonD
ParametersJSON Schema
NameRequiredDescriptionDefault
typeYesLesson type (optional)
imageNoLesson image URL (optional)
titleYesLesson title (required, automatically generates slug)
skillsNoArray of skill IDs from libservice (optional, can be empty array)
contentNoMain lesson content (HTML/Markdown, required if contentType !== "mixed")
isDraftNoIs draft (optional, default: true)
durationNoLesson duration in minutes (optional, default: 0)
lessonIdYesLesson ID for update
videoUrlNoVideo URL (for video type lessons)
resourcesNoAdditional resources
contentTypeYesContent type (optional)
descriptionNoLesson description (optional)
professionsNoArray of profession IDs from libservice (optional, can be empty array)
contentBlocksNoContent blocks (required if contentType === "mixed")
practiceExercisesNoPractice exercises

TDQS

D1/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Tool has no description.

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?

Tool has no description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tool has no description.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Tool has no description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

update_moduleD
ParametersJSON Schema
NameRequiredDescriptionDefault
titleYesModule title (required, automatically generates slug)
contentYesModule description (required, plain text)
isDraftNoIs draft (optional, default: true)
lessonsNoArray of lesson IDs (can be empty array)
moduleIdYesModule ID for update
videoUrlNoVideo URL for module (optional)
descriptionNoModule description (optional)
previewImageNoPreview image URL (optional)

TDQS

D1/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Tool has no description.

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?

Tool has no description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tool has no description.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Tool has no description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

update_testD
ParametersJSON Schema
NameRequiredDescriptionDefault
titleYesTest title (required, automatically generates slug)
lessonYesLesson ID (required)
testIdYesTest ID for update
questionsYesArray of test questions
timeLimitNoTime limit in minutes (optional)
descriptionNoTest description (optional)
passingScoreNoMinimum score to pass (0-100)

TDQS

D1/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Tool has no description.

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?

Tool has no description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tool has no description.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Tool has no description.

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. 19 tool updatesv2.0.0
    • First observedcreate_course
    • First observedcreate_lesson
    • First observedcreate_module
    • First observedcreate_test
    • First observedget_course
    • First observedget_courses
    • First observedget_lesson
    • First observedget_lessons
    • First observedget_module
    • First observedget_modules
    • First observedget_professions
    • First observedget_skills
    • First observedget_test
    • First observedget_tests
    • First observedget_tools
    • First observedupdate_course
    • First observedupdate_lesson
    • First observedupdate_module
    • First observedupdate_test

TDQS

D1.8/5.0

Scored across 19 tools

Disambiguation4/5

Most tools are clearly distinguished by entity and action, with predictable pairs like get_course/get_courses and create_lesson/update_lesson. The lack of descriptions creates some ambiguity around closely named resources, but the naming is distinct enough for an agent to select correctly.

Naming Consistency5/5

All tools follow a consistent verb_noun pattern using get_, create_, and update_ prefixes. The use of singular nouns for mutations and plural or singular nouns for reads is predictable and uniform across the entire set.

Tool Count3/5

At 19 tools, the server is within the borderline-heavy range for a content-management domain. The count is manageable but slightly above the ideal 3-15 scope, suggesting some consolidation might improve focus.

Completeness3/5

Core entities like courses, lessons, modules, and tests have get/create/update operations, but no delete operations exist for any mutable resource. Professions, skills, and tools are read-only, which may be intentional but leaves the overall lifecycle incomplete.

Maintenance

ActivityInactive
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers