Skip to content

saddamalsalfi/moodle-plugins-and-themes

unversioned · 7a0457229b79MIT

Develop, review, and package Moodle LMS plugins and themes. Use for plugin types and Frankenstyle names, version.php and XMLDB upgrades, contexts and capabilities, the Privacy API, tasks, Mustache, AMD, and parent themes.

Moodle Plugins and Themes

العربية · Skill · Examples · MIT License

An independent Agent Skill for Moodle extension development. Keeps the source-repository name, Frankenstyle component, installed short directory, and ZIP wrapper distinct. This is instruction and reference content for coding agents, not an installable Moodle extension. The skill name is not the runtime identifier of any extension you build.

What it covers

  • Resolve the plugin type and code root in the target checkout, including branches with a public webroot.
  • Plan versioned XMLDB upgrades, context capabilities, privacy interfaces, and recoverable tasks.
  • Preserve Mustache, AMD, and parent-theme contracts; verify clean install, upgrade, and release ZIP layout.

Install

Copy the whole skills/moodle-plugins-and-themes/ folder into a discovery directory in the target application. Keep its name, references, and examples intact.

AgentProject directory
Codex.agents/skills/
Claude Code.claude/skills/
Cursor.agents/skills/ or .cursor/skills/
GitHub Copilot.github/skills/ or .agents/skills/ where supported
Google Antigravity.agents/skills/

A single copy in .agents/skills/ works for clients that share that project path. Use the client-specific path when required; avoid duplicate copies for the same client.

For example, from the target project root (PowerShell; point $skill to the checked-out skill directory, and use a fresh destination):

$skill = 'C:/path/to/moodle-plugins-and-themes/skills/moodle-plugins-and-themes'
New-Item -ItemType Directory -Path '.agents/skills' -Force | Out-Null
Copy-Item -LiteralPath $skill -Destination '.agents/skills/' -Recurse

Optional installer: From the target project, use a local checkout with the skills CLI:

npx skills add "/path/to/moodle-plugins-and-themes" --list
npx skills add "/path/to/moodle-plugins-and-themes" --skill moodle-plugins-and-themes

After publishing to GitHub, pass the repository's OWNER/REPO instead of the local path. This works independently of the optional Agent Plugins manifest. Installing the native skill does not start or require the optional MCP server or Docker. See the client's documentation for hosted or organization-managed installations.

Optional Cursor rule: After installing the skill, copy the manual rule to the target project's .cursor/rules/ and mention @moodle-plugins-and-themes as a rule in chat. Prefer the native skill when available; this shortcut does not replace it. Cursor rules docs

MCP and Docker

Use the read-only MCP server if your client needs MCP instead of direct skill discovery. It serves the same bundled references over stdio or Streamable HTTP. See the setup and publishing guide for Python, Docker, Glama, and the official MCP Registry.

Try it

Use the moodle-plugins-and-themes skill. Prepare this Moodle plugin for an upgrade that adds a user-linked record. Confirm the component and code root, use the matching upgrade savepoint and Privacy API interfaces, and verify clean installation, upgrade, and role boundaries.

In Codex you can also start with $moodle-plugins-and-themes; in Claude Code, use /moodle-plugins-and-themes. The skill reports in the user's language unless they request another.

Maintainer checks

Run from this repository root with Python 3.10+:

python -B -m unittest discover -s tests -v

The standard-library checks cover installation, metadata, and local links. To exercise MCP, install the locked dependencies as described in the setup guide and rerun the suite. The GitHub Actions workflow runs these checks on Windows and Linux. They do not exercise Moodle runtime code or certify that a resulting package is compatible or accepted upstream.

This repository is independent and not endorsed by Moodle. The MIT license applies to this skill; check the applicable license and directory requirements for any extension it helps you build.

Source

Adapted from the project guide moodle-plugin-and-theme-best-practices.md. Topic-specific documentation is bundled under skills/moodle-plugins-and-themes/references/.