From c47ec7fd286fa4cad801ba4bc705388bc55e2fbb Mon Sep 17 00:00:00 2001 From: airano-ir Date: Thu, 2 Apr 2026 00:38:46 +0200 Subject: [PATCH] =?UTF-8?q?docs:=20fix=20tool=20counts=20(596=E2=86=92565)?= =?UTF-8?q?,=20update=20live=20URL,=20clean=20Docker=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Fix tool count: 596→565 (OpenPanel reduced from 73→42 in v3.4.0) - Update DOCKER_README: dashboard-first site configuration - Update .env.example version to 3.4.0 Co-Authored-By: Claude Opus 4.6 (1M context) --- .env.example | 8 ++++---- DOCKER_README.md | 12 ++++-------- README.md | 32 +++++++++++++++----------------- docs/getting-started.md | 14 +++++++------- 4 files changed, 30 insertions(+), 36 deletions(-) diff --git a/.env.example b/.env.example index c5e52ba..df234a5 100644 --- a/.env.example +++ b/.env.example @@ -2,8 +2,8 @@ # MCP Hub - Environment Configuration # ============================================================================== # -# Version: 3.0.0 -# Last Updated: 2026-02-17 +# Version: 3.4.0 +# Last Updated: 2026-04-02 # # This file contains environment variables needed to run the MCP server. # Copy this file to .env and fill in your actual values. @@ -14,7 +14,7 @@ # SECURITY NOTE: Never commit .env file to version control! # # Multi-Endpoint Architecture (v3.0.0): -# - /mcp → Admin (all 587 tools, Master API Key required) +# - /mcp → Admin (all 565 tools, Master API Key required) # - /system/mcp → System (17 tools, Master Key) # - /wordpress/mcp → WordPress Core (65 tools) # - /woocommerce/mcp → WooCommerce (28 tools) @@ -22,7 +22,7 @@ # - /gitea/mcp → Gitea (56 tools) # - /n8n/mcp → n8n Automation (56 tools) # - /supabase/mcp → Supabase Self-Hosted (70 tools) -# - /openpanel/mcp → OpenPanel Analytics (73 tools) +# - /openpanel/mcp → OpenPanel Analytics (42 tools) # - /appwrite/mcp → Appwrite Backend (100 tools) # - /directus/mcp → Directus CMS (100 tools) # - /project/{alias}/mcp → Project-specific (site-locked tools) diff --git a/DOCKER_README.md b/DOCKER_README.md index 7059788..a3d5b81 100644 --- a/DOCKER_README.md +++ b/DOCKER_README.md @@ -2,7 +2,7 @@ **The AI-native management hub for WordPress, WooCommerce, and self-hosted services.** -596 tools across 9 plugins. Connect your sites, stores, repos, and databases — manage them all through Claude, ChatGPT, Cursor, or any MCP client. +565 tools across 9 plugins. Connect your sites, stores, repos, and databases — manage them all through Claude, ChatGPT, Cursor, or any MCP client. > **Don't want to self-host?** Try the hosted instance at **[mcp.palebluedot.live](https://mcp.palebluedot.live)** — log in with GitHub or Google, add your sites, and connect your AI client in minutes. @@ -13,14 +13,10 @@ ```bash # Recommended (auto-generates temp key if omitted — check container logs) MASTER_API_KEY=your-secure-key-here - -# Add at least one WordPress site -WORDPRESS_SITE1_URL=https://your-site.com -WORDPRESS_SITE1_USERNAME=admin -WORDPRESS_SITE1_APP_PASSWORD=xxxx xxxx xxxx xxxx -WORDPRESS_SITE1_ALIAS=mysite ``` +After starting, open the **web dashboard** to add your sites — no env vars needed for site configuration. + ### 2. Run the container ```bash @@ -96,7 +92,7 @@ Use the most specific endpoint for your use case: | `/u/{user_id}/{alias}/mcp` | 22-100 | No (pre-scoped) | Hosted/OAuth users | | `/project/{alias}/mcp` | 22-100 | No (pre-scoped) | Single-site workflow | | `/{plugin}/mcp` | 23-101 | Yes | Multi-site management | -| `/mcp` | 596 | Yes | Admin & discovery only | +| `/mcp` | 565 | Yes | Admin & discovery only | Available plugin endpoints: `/wordpress/mcp`, `/woocommerce/mcp`, `/wordpress-advanced/mcp`, `/gitea/mcp`, `/n8n/mcp`, `/supabase/mcp`, `/openpanel/mcp`, `/appwrite/mcp`, `/directus/mcp`, `/system/mcp` diff --git a/README.md b/README.md index 93762c6..f9de079 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Connect your sites, stores, repos, and databases — manage them all through Cla [![PyPI](https://img.shields.io/pypi/v/mcphub-server.svg)](https://pypi.org/project/mcphub-server/) [![Docker](https://img.shields.io/docker/v/airano/mcphub?label=docker)](https://hub.docker.com/r/airano/mcphub) [![Tests: 481 passing](https://img.shields.io/badge/tests-481%20passing-brightgreen.svg)]() -[![Tools: 596](https://img.shields.io/badge/tools-596-orange.svg)]() +[![Tools: 565](https://img.shields.io/badge/tools-565-orange.svg)]() [![CI](https://github.com/airano-ir/mcphub/actions/workflows/ci.yml/badge.svg)](https://github.com/airano-ir/mcphub/actions/workflows/ci.yml) @@ -49,7 +49,7 @@ MCP Hub is the first MCP server that lets you manage WordPress, WooCommerce, and --- -## 596 Tools Across 9 Plugins +## 565 Tools Across 9 Plugins | Plugin | Tools | What You Can Do | |--------|-------|-----------------| @@ -59,11 +59,11 @@ MCP Hub is the first MCP server that lets you manage WordPress, WooCommerce, and | **Gitea** | 56 | Repos, issues, pull requests, releases, webhooks, organizations | | **n8n** | 56 | Workflows, executions, credentials, variables, audit | | **Supabase** | 70 | Database, auth, storage, edge functions, realtime | -| **OpenPanel** | 73 | Events, funnels, profiles, dashboards, projects | +| **OpenPanel** | 42 | Events, export, insights, profiles, projects, system | | **Appwrite** | 100 | Databases, auth, storage, functions, teams, messaging | | **Directus** | 100 | Collections, items, users, files, flows, permissions | | **System** | 24 | Health monitoring, API keys, OAuth management, audit | -| **Total** | **596** | Constant count — scales to unlimited sites | +| **Total** | **565** | Constant count — scales to unlimited sites | --- @@ -75,14 +75,14 @@ MCP Hub is the first MCP server that lets you manage WordPress, WooCommerce, and git clone https://github.com/airano-ir/mcphub.git cd mcphub cp env.example .env -# Edit .env — set MASTER_API_KEY and add your site credentials +# Edit .env — set MASTER_API_KEY, then add sites via the web dashboard docker compose up -d ``` ### Option 2: Docker Hub (No Clone) ```bash -# Create a .env file with your credentials (see "Configure Your Sites" below) +# Create a .env file with MASTER_API_KEY (see "Configure Your Sites" below) docker run -d --name mcphub -p 8000:8000 --env-file .env airano/mcphub:latest ``` @@ -93,7 +93,7 @@ git clone https://github.com/airano-ir/mcphub.git cd mcphub pip install -e . cp env.example .env -# Edit .env with your site credentials +# Edit .env — set MASTER_API_KEY python server.py --transport streamable-http --port 8000 ``` @@ -265,7 +265,7 @@ MCP Hub supports **Open Dynamic Client Registration** (RFC 7591). ChatGPT can au ## Architecture ``` -/mcp → Admin endpoint (all 596 tools) +/mcp → Admin endpoint (all 565 tools) /system/mcp → System tools only (24 tools) /wordpress/mcp → WordPress tools (67 tools) /woocommerce/mcp → WooCommerce tools (28 tools) @@ -273,21 +273,21 @@ MCP Hub supports **Open Dynamic Client Registration** (RFC 7591). ChatGPT can au /gitea/mcp → Gitea tools (56 tools) /n8n/mcp → n8n tools (56 tools) /supabase/mcp → Supabase tools (70 tools) -/openpanel/mcp → OpenPanel tools (73 tools) +/openpanel/mcp → OpenPanel tools (42 tools) /appwrite/mcp → Appwrite tools (100 tools) /directus/mcp → Directus tools (100 tools) /project/{alias}/mcp → Per-project endpoint (auto-injects site) /u/{user_id}/{alias}/mcp → Per-user endpoint (hosted/OAuth users) ``` -**Recommendation**: Use plugin-specific endpoints instead of `/mcp` (596 tools) to minimize token usage. +**Recommendation**: Use plugin-specific endpoints instead of `/mcp` (565 tools) to minimize token usage. | Endpoint | Use Case | Tools | |----------|----------|------:| | `/u/{user_id}/{alias}/mcp` | Hosted users (OAuth login) | 22-100 | | `/project/{alias}/mcp` | Single-site workflow (recommended) | 22-100 | | `/{plugin}/mcp` | Multi-site management | 23-101 | -| `/mcp` | Admin & discovery only | 596 | +| `/mcp` | Admin & discovery only | 565 | ### Security @@ -306,21 +306,19 @@ Some MCP Hub tools require companion WordPress plugins: | Tools | Requirement | |-------|-------------| | SEO tools (`wordpress_get_post_seo`, etc.) | [Airano MCP SEO Bridge](https://wordpress.org/plugins/airano-mcp-seo-bridge/) ([GitHub](wordpress-plugin/airano-mcp-seo-bridge/)) + Rank Math or Yoast SEO | -| WP-CLI tools (15 tools: `wp_cache_*`, `wp_db_*`, etc.) | Docker socket + `CONTAINER` env var | -| WordPress Advanced database/system tools | Docker socket + `CONTAINER` env var | +| WP-CLI tools (15 tools: `wp_cache_*`, `wp_db_*`, etc.) | Docker socket + `CONTAINER` config | +| WordPress Advanced database/system tools | Docker socket + `CONTAINER` config | | OpenPanel analytics integration | [OpenPanel Self-Hosted](wordpress-plugin/openpanel-self-hosted/) ([Download ZIP](wordpress-plugin/openpanel-self-hosted.zip)) | -| WooCommerce tools | WooCommerce plugin (separate `WOOCOMMERCE_` config) | +| WooCommerce tools | WooCommerce plugin installed on your WordPress site | **Docker socket** is needed for WP-CLI and WordPress Advanced system tools. Add to your docker-compose: ```yaml volumes: - /var/run/docker.sock:/var/run/docker.sock:ro -environment: - WORDPRESS_SITE1_CONTAINER: your-wp-container-name ``` -Without Docker socket, WP-CLI tools return "not available" but all REST API tools work normally. +Set the `container` field when adding a WordPress site in the dashboard. Without Docker socket, WP-CLI tools return "not available" but all REST API tools work normally. --- diff --git a/docs/getting-started.md b/docs/getting-started.md index b24f959..de3fb26 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -357,7 +357,7 @@ After starting (via Docker or locally), wait ~30 seconds for the server to initi ```bash curl http://localhost:8000/health -# Expected: {"status": "ok", "tools_loaded": 596, ...} +# Expected: {"status": "ok", "tools_loaded": 565, ...} ``` **2. Open the web dashboard:** @@ -481,7 +481,7 @@ MCP Hub supports **Open Dynamic Client Registration** (RFC 7591). ChatGPT can au ## Using MCP Tools -### 596 Tools Across 9 Plugins +### 565 Tools Across 9 Plugins | Plugin | Tools | Env Prefix | |--------|-------|------------| @@ -491,7 +491,7 @@ MCP Hub supports **Open Dynamic Client Registration** (RFC 7591). ChatGPT can au | Gitea | 56 | `GITEA_` | | n8n | 56 | `N8N_` | | Supabase | 70 | `SUPABASE_` | -| OpenPanel | 73 | `OPENPANEL_` | +| OpenPanel | 42 | `OPENPANEL_` | | Appwrite | 100 | `APPWRITE_` | | Directus | 100 | `DIRECTUS_` | | System | 24 | (no config needed) | @@ -518,9 +518,9 @@ Use the most specific endpoint for your use case to minimize token usage: | `/project/{alias}/mcp` | Single-site workflow | 22-100 | No (pre-scoped) | | `/{plugin}/mcp` | Multi-site management | 23-101 | Yes | | `/system/mcp` | System administration | 24 | N/A | -| `/mcp` | Admin & discovery only | 596 | Yes | +| `/mcp` | Admin & discovery only | 565 | Yes | -> **Recommendation**: Always use the most specific endpoint. Using `/mcp` (596 tools) wastes context tokens and degrades AI response quality. +> **Recommendation**: Always use the most specific endpoint. Using `/mcp` (565 tools) wastes context tokens and degrades AI response quality. **Available plugin endpoints:** @@ -532,7 +532,7 @@ Use the most specific endpoint for your use case to minimize token usage: | `/gitea/mcp` | Gitea | 56 | | `/n8n/mcp` | n8n | 56 | | `/supabase/mcp` | Supabase | 70 | -| `/openpanel/mcp` | OpenPanel | 73 | +| `/openpanel/mcp` | OpenPanel | 42 | | `/appwrite/mcp` | Appwrite | 100 | | `/directus/mcp` | Directus | 100 | | `/system/mcp` | System Management | 24 | @@ -638,7 +638,7 @@ After deployment, add sites via the web dashboard at `https://your-domain.com/da ## Next Steps -1. **Explore the full tool list**: See the [README](../README.md) for all 596 tools +1. **Explore the full tool list**: See the [README](../README.md) for all 565 tools 2. **Set up API keys**: [API Keys Guide](API_KEYS_GUIDE.md) for per-project access control 3. **Configure OAuth**: [OAuth Guide](OAUTH_GUIDE.md) for Claude/ChatGPT auto-registration 4. **Monitor health**: Use `check_all_projects_health` tool or visit the web dashboard