Files
mcp-mokosuite-api/README.md
T
jmiller c96153f145
Universal: Pre-Release / Build Pre-Release (${{ inputs.stability || github.ref_name }}) (push) Successful in 8s
chore: rebrand mokowaas→mokosuite
2026-07-05 02:20:51 +00:00

105 lines
3.7 KiB
Markdown

# joomla-api-mcp
MCP server for Joomla Web Services API operations
![Language](https://img.shields.io/badge/Markdown-000000?style=flat-square&logo=markdown&logoColor=white) ![License](https://img.shields.io/badge/license-GPL--3.0--or--later-green?style=flat-square) ![Wiki](https://img.shields.io/badge/wiki-joomla-api-mcp-blue?style=flat-square)
Model Context Protocol server for the Joomla Web Services API -- full CRUD for articles, categories, users, menus, contacts, tags, media, plugins, and more.
---
| | |
|---|---|
| **Type** | MCP Server |
| **Language** | Node.js |
| **Tools** | 67 tools across 15 resource groups |
| **License** | GPL-3.0-or-later |
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/joomla-api-mcp) (primary) |
---
## Overview
joomla-api-mcp wraps the entire Joomla Web Services REST API into MCP tools that Claude Code can call directly. It supports multi-site connections via named connection configs.
### Resource Coverage
| Group | Operations |
|-------|------------|
| Articles | list, get, create, update, delete |
| Categories | list, create, update, delete |
| Users | list, get, create, update, delete, groups |
| Contacts | list, get, create, update, delete |
| Menus | list types, list/get/create/update/delete items |
| Tags | list, get, create, update, delete |
| Custom Fields | list, get, create, delete |
| Plugins | list, update (enable/disable) |
| Modules | list |
| Templates | list |
| Media | list, get file, delete file, create folder |
| Banners | list, get, create, delete, list clients |
| Newsfeeds | list, get, create, delete |
| Messages | list, get, send, delete |
| Redirects | list, create, delete |
| Config | get, update |
| Content History | list versions |
| Checkin | unlock checked-out items |
| Associations | list multilingual associations |
| Generic | raw API request, list connections |
---
## Wiki Pages
### Guides
- [Installation](https://git.mokoconsulting.tech/MokoConsulting/joomla-api-mcp/wiki/INSTALLATION) -- setup, .env configuration, Claude Code registration, multi-site connections
### Reference
- [API](https://git.mokoconsulting.tech/MokoConsulting/joomla-api-mcp/wiki/API) -- all 67 tools with parameters, grouped by resource type
- [Architecture](https://git.mokoconsulting.tech/MokoConsulting/joomla-api-mcp/wiki/ARCHITECTURE) -- source file map, component design, connection handling
### Templates
- [Templates Index](https://git.mokoconsulting.tech/MokoConsulting/joomla-api-mcp/wiki/templates-index) -- workflow and config templates
- [README Template](templates-README-template) -- README template for MCP repos
---
## Related Wikis
| Repo | Purpose |
|------|---------|
| [backup-mcp](https://git.mokoconsulting.tech/MokoConsulting/backup-mcp/wiki) | Backup MCP (uses Joomla API for Akeeba) |
| [MokoSuite](https://git.mokoconsulting.tech/MokoConsulting/MokoSuite/wiki) | Joomla WaaS system plugin |
| [Template-Client-WaaS](https://git.mokoconsulting.tech/MokoConsulting/Template-Client-WaaS/wiki) | Client site template |
| [MokoOnyx](https://git.mokoconsulting.tech/MokoConsulting/MokoOnyx/wiki) | Joomla admin template |
---
> **[MokoCLI](https://git.mokoconsulting.tech/MokoConsulting/mokocli)** -- enterprise CLI automation for all Moko Consulting repositories.
---
---
## Documentation
Full documentation is available on the [Wiki](https://git.mokoconsulting.tech/MokoConsulting/joomla-api-mcp/wiki).
## Contributing
See the wiki for development guidelines and contribution instructions.
## License
This project is licensed under the GNU General Public License v3.0 or later -- see the [LICENSE](LICENSE) file.
---
*[Moko Consulting](https://mokoconsulting.tech) -- [MokoCLI](https://git.mokoconsulting.tech/MokoConsulting/mokocli)*