Joomla MCP

by nasoma

21 stars

407 downloads

Not rated

GitHub

About

The Joomla MCP Server facilitates interaction between AI assistants (like Claude) and Joomla websites through the Joomla Web Services API. It provides tools to manage articles, including retrieving, creating, updating, and deleting content, as well as managing article states.

Details

Author: nasoma
GitHub stars: 21
Downloads: 407
Categories: Cloud Service, Other

- Retrieve all articles from a Joomla website
- List all content categories
- Create new articles with optional plain-text-to-HTML conversion
- Manage article states (published, unpublished, trashed, archived)
- Delete articles
- Update articles (requires both introtext and fulltext with a "Read more" break)

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

Download and install Highlight from highlightai.com/download
Navigate to the plugins tab and select "Add Custom Plugin"
Configure the plugin with the settings below

Plugin Name Joomla MCP

Command (node, npx, python, etc.)

Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
Enable "Start Automatically" if you want the plugin to start when Highlight launches

Setting up with Cursor

Open Cursor's settings
Navigate to the MCP section
Click "Add new Global MCP server"
Copy and paste the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "joomla mcp": {
            "Joomla Articles MCP": {
                "command": "{{PATH_TO_UV}}",
                "args": [
                    "--directory",
                    "{{PATH_TO_PROJECT}}",
                    "run",
                    "main.py"
                ],
                "env": {
                    "JOOMLA_BASE_URL": "<your_joomla_website_url>",
                    "BEARER_TOKEN": "<your_joomla_api_token>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "joomla mcp": {
            "Joomla Articles MCP": {
                "command": "{{PATH_TO_UV}}",
                "args": [
                    "--directory",
                    "{{PATH_TO_PROJECT}}",
                    "run",
                    "main.py"
                ],
                "env": {
                    "JOOMLA_BASE_URL": "<your_joomla_website_url>",
                    "BEARER_TOKEN": "<your_joomla_api_token>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "joomla mcp": {
            "Joomla Articles MCP": {
                "command": "{{PATH_TO_UV}}",
                "args": [
                    "--directory",
                    "{{PATH_TO_PROJECT}}",
                    "run",
                    "main.py"
                ],
                "env": {
                    "JOOMLA_BASE_URL": "<your_joomla_website_url>",
                    "BEARER_TOKEN": "<your_joomla_api_token>"
                }
            }
        }
    }
}

Setting up with Claude Desktop

Open Claude Desktop's settings
Go to the Integrations tab
Click "Add MCP Server"
Use the configuration below based on your operating system

Note: Make sure Claude Desktop is running before attempting to connect.

JSON

{
    "mcpServers": {
        "joomla mcp": {
            "Joomla Articles MCP": {
                "command": "{{PATH_TO_UV}}",
                "args": [
                    "--directory",
                    "{{PATH_TO_PROJECT}}",
                    "run",
                    "main.py"
                ],
                "env": {
                    "JOOMLA_BASE_URL": "<your_joomla_website_url>",
                    "BEARER_TOKEN": "<your_joomla_api_token>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "joomla mcp": {
            "Joomla Articles MCP": {
                "command": "{{PATH_TO_UV}}",
                "args": [
                    "--directory",
                    "{{PATH_TO_PROJECT}}",
                    "run",
                    "main.py"
                ],
                "env": {
                    "JOOMLA_BASE_URL": "<your_joomla_website_url>",
                    "BEARER_TOKEN": "<your_joomla_api_token>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "joomla mcp": {
            "Joomla Articles MCP": {
                "command": "{{PATH_TO_UV}}",
                "args": [
                    "--directory",
                    "{{PATH_TO_PROJECT}}",
                    "run",
                    "main.py"
                ],
                "env": {
                    "JOOMLA_BASE_URL": "<your_joomla_website_url>",
                    "BEARER_TOKEN": "<your_joomla_api_token>"
                }
            }
        }
    }
}

Setting up with Windsurf

Open Windsurf's preferences
Go to the Integrations section
Click "Add MCP Integration"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "joomla mcp": {
            "Joomla Articles MCP": {
                "command": "{{PATH_TO_UV}}",
                "args": [
                    "--directory",
                    "{{PATH_TO_PROJECT}}",
                    "run",
                    "main.py"
                ],
                "env": {
                    "JOOMLA_BASE_URL": "<your_joomla_website_url>",
                    "BEARER_TOKEN": "<your_joomla_api_token>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "joomla mcp": {
            "Joomla Articles MCP": {
                "command": "{{PATH_TO_UV}}",
                "args": [
                    "--directory",
                    "{{PATH_TO_PROJECT}}",
                    "run",
                    "main.py"
                ],
                "env": {
                    "JOOMLA_BASE_URL": "<your_joomla_website_url>",
                    "BEARER_TOKEN": "<your_joomla_api_token>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "joomla mcp": {
            "Joomla Articles MCP": {
                "command": "{{PATH_TO_UV}}",
                "args": [
                    "--directory",
                    "{{PATH_TO_PROJECT}}",
                    "run",
                    "main.py"
                ],
                "env": {
                    "JOOMLA_BASE_URL": "<your_joomla_website_url>",
                    "BEARER_TOKEN": "<your_joomla_api_token>"
                }
            }
        }
    }
}

Setting up with Cline

Open Cline's settings
Navigate to the Integrations section
Click "Add MCP Server"
Copy and paste the configuration below based on your operating system

Note: Make sure to restart Cline after adding the configuration.

JSON

{
    "mcpServers": {
        "joomla mcp": {
            "Joomla Articles MCP": {
                "command": "{{PATH_TO_UV}}",
                "args": [
                    "--directory",
                    "{{PATH_TO_PROJECT}}",
                    "run",
                    "main.py"
                ],
                "env": {
                    "JOOMLA_BASE_URL": "<your_joomla_website_url>",
                    "BEARER_TOKEN": "<your_joomla_api_token>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "joomla mcp": {
            "Joomla Articles MCP": {
                "command": "{{PATH_TO_UV}}",
                "args": [
                    "--directory",
                    "{{PATH_TO_PROJECT}}",
                    "run",
                    "main.py"
                ],
                "env": {
                    "JOOMLA_BASE_URL": "<your_joomla_website_url>",
                    "BEARER_TOKEN": "<your_joomla_api_token>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "joomla mcp": {
            "Joomla Articles MCP": {
                "command": "{{PATH_TO_UV}}",
                "args": [
                    "--directory",
                    "{{PATH_TO_PROJECT}}",
                    "run",
                    "main.py"
                ],
                "env": {
                    "JOOMLA_BASE_URL": "<your_joomla_website_url>",
                    "BEARER_TOKEN": "<your_joomla_api_token>"
                }
            }
        }
    }
}

Setting up with Goose

Open Goose's preferences
Go to the Integrations tab
Select "MCP Servers"
Click "Add New Server"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "joomla mcp": {
            "Joomla Articles MCP": {
                "command": "{{PATH_TO_UV}}",
                "args": [
                    "--directory",
                    "{{PATH_TO_PROJECT}}",
                    "run",
                    "main.py"
                ],
                "env": {
                    "JOOMLA_BASE_URL": "<your_joomla_website_url>",
                    "BEARER_TOKEN": "<your_joomla_api_token>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "joomla mcp": {
            "Joomla Articles MCP": {
                "command": "{{PATH_TO_UV}}",
                "args": [
                    "--directory",
                    "{{PATH_TO_PROJECT}}",
                    "run",
                    "main.py"
                ],
                "env": {
                    "JOOMLA_BASE_URL": "<your_joomla_website_url>",
                    "BEARER_TOKEN": "<your_joomla_api_token>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "joomla mcp": {
            "Joomla Articles MCP": {
                "command": "{{PATH_TO_UV}}",
                "args": [
                    "--directory",
                    "{{PATH_TO_PROJECT}}",
                    "run",
                    "main.py"
                ],
                "env": {
                    "JOOMLA_BASE_URL": "<your_joomla_website_url>",
                    "BEARER_TOKEN": "<your_joomla_api_token>"
                }
            }
        }
    }
}

From the repository

Install Python 3.11+, clone the repository, set up a virtual environment with uv, and configure the server in your AI assistant (e.g., Claude Desktop) by providing the Joomla base URL and a bearer token in environment variables.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "joomla mcp": {
            "Joomla Articles MCP": {
                "command": "{{PATH_TO_UV}}",
                "args": [
                    "--directory",
                    "{{PATH_TO_PROJECT}}",
                    "run",
                    "main.py"
                ],
                "env": {
                    "JOOMLA_BASE_URL": "<your_joomla_website_url>",
                    "BEARER_TOKEN": "<your_joomla_api_token>"
                }
            }
        }
    }
}

McpServers

{
    "Joomla Articles MCP": {
        "command": "{{PATH_TO_UV}}",
        "args": [
            "--directory",
            "{{PATH_TO_PROJECT}}",
            "run",
            "main.py"
        ],
        "env": {
            "JOOMLA_BASE_URL": "<your_joomla_website_url>",
            "BEARER_TOKEN": "<your_joomla_api_token>"
        }
    }
}

Joomla MCP Server

- Introduction - Features - Requirements - Installation - Available Tools - Security Considerations

Introduction

The Joomla MCP (Model Context Protocol) Server enables AI assistants, such as Claude, to interact with Joomla websites via the Joomla Web Services API. It provides tools to manage articles using an AI assistant.

Features

- Retrieve all articles from a Joomla website - List all content categories - Create new articles - Manage article states (published, unpublished, trashed, or archived) - Delete articles - Update articles (requires both introtext and fulltext, with a "Read more" break)

Requirements

- Python 3.11+ - Joomla 4.x or 5.x with the Web Services API plugin enabled - API Bearer token for authentication

Installation

Create a Joomla API Token

1. Access User Profile: Log in to the Joomla Administrator interface and navigate to the Users menu, then select Manage.

2. Edit Super User: Find and click on the Super User account (or the desired user) to edit their profile.

3. Generate Token: Go to the Joomla API Token tab, click the Generate button, and copy the displayed token.

Install the Project/Server locally

1. Clone the repository:

git clone https://github.com/nasoma/joomla-mcp-server.git cd joomla-mcp-server

2. Set up a virtual environment and install dependencies using uv (a Python dependency manager, see uv documentation). If uv is installed run:

uv sync

Installing on Claude or other AI assistants

Claude Desktop

Add this to your claude_desktop_config.json:

{
  "mcpServers": {
    "Joomla Articles MCP": {
      "command": "{{PATH_TO_UV}}",
      "args": [
        "--directory",
        "{{PATH_TO_PROJECT}}",
        "run",
        "main.py"
      ],
      "env": {
        "JOOMLA_BASE_URL": "<your_joomla_website_url>",
        "BEARER_TOKEN": "<your_joomla_api_token>"
      }
    }
  }
}

Replace {{PATH_TO_UV}} with the path to uv (run which uv to find it) and {{PATH_TO_PROJECT}} with the project directory path (run pwd in the repository root).

Available Tools

1. get_joomla_articles()

Retrieves all articles from the Joomla website via its API.

2. get_joomla_categories()

Retrieves all categories from the Joomla website and formats them in a readable list.

3. create_article()

Creates a new article on the Joomla website via its API.

Parameters:
- article_text (required): The content of the article (plain text or HTML)
- title (optional): The article title (inferred from content if not provided)
- category_id (optional): The category ID for the article
- convert_plain_text (optional, default: True): Auto-converts plain text to HTML
- published (optional, default: True): Publishes the article immediately

4. manage_article_state()

Manages the state of an existing article on the Joomla website via its API.

Parameters:
- article_id (required): The ID of the existing article to check and update
- target_state (required): The desired state for the article (1=published, 0=unpublished, 2=archived, -2=trashed)

5. delete_article()

Deletes an article from the Joomla website via its API.

Parameters:
- article_id (required): The ID of the article to delete

6. update_article()

Updates an existing article on the Joomla website via its API. Both introtext and fulltext are required to align with Joomla's article structure (introtext for the teaser, fulltext for the content after a "Read more" break).

Parameters:
- article_id (required): The ID of the article to update
- title (optional): New title for the article
- introtext (required): Introductory text for the article (plain text or HTML)
- fulltext (required): Full content for the article (plain text or HTML)
- metadesc (optional): Meta description for the article

Security Considerations

- The Joomla API Token has access to your site. Treat it the same way you treat your passwords.
- The server sanitizes HTML content to prevent XSS attacks
- Ensure your Joomla website uses HTTPS to secure API communications.

License

This project is licensed under the MIT License.

No reviews yet — be the first

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.

About

Details

Jump to

Setting up with Highlight

From the repository

Claude Desktop / Cursor

McpServers

Joomla MCP Server

Table of Contents

Introduction

Features

Requirements

Installation

Create a Joomla API Token

Install the Project/Server locally

Installing on Claude or other AI assistants

Claude Desktop

Available Tools

1. get_joomla_articles()

2. get_joomla_categories()

3. create_article()

4. manage_article_state()

5. delete_article()

6. update_article()

Security Considerations

License

Install

More like this

Sequential Thinking

Aws Kb Retrieval Server

Filesystem

EverArt

Google Drive

Reactive Resume