Ghost MCP

🚀 Ghost MCP Server

A Model Context Protocol (MCP) server for interacting with Ghost CMS through a Large Language Model (LLM) interface. It provides secure and comprehensive access to Ghost blogs.

💡 Important Notice: Migration from Python to TypeScript

I've completely rewritten the Ghost MCP Server in TypeScript and released it in version v0.1.0. This major change brings the following benefits:

• Simplified Installation: Now available as an NPM package (@fanyangmeng/ghost-mcp).
• Improved Reliability: Uses the official @tryghost/admin-api client instead of a custom implementation.
• Easier Maintenance: TypeScript offers type safety and better code organization.
• Cleaner Configuration: Only requires setting Node.js environment variables.

Major Changes

• Python dependencies are no longer needed.
• Configuration method has changed (now uses Node.js environment variables).
• Docker deployment is simplified.
• Installation process has changed (now uses NPM).

Please refer to the updated documentation below to learn how to migrate from the Python version. If you encounter any issues, please submit an issue on GitHub.

A Model Context Protocol (MCP) server for interacting with Ghost CMS through a Large Language Model (LLM) interface. This server provides secure and comprehensive access to Ghost blogs and utilizes JWT authentication and a rich MCP toolset to support managing articles, users, members, subscription tiers, offers, and newsletters.

✨ Features

• Securely request the Ghost Admin API using @tryghost/admin-api.
• Comprehensive access to entities including articles, users, members, subscription tiers, offers, and newsletters.
• Advanced search functionality with fuzzy and exact matching options.
• Detailed and easy-to-understand entity output.
• Error handling using custom GhostError exceptions.
• Integrated logging support (through MCP context) for easy troubleshooting.

🚀 Quick Start

To use this MCP server, add the following to your claude_desktop.yaml:

ghost-mcp-server:
  enabled: true
  endpoint: http://localhost:5000

The default port is 5000. Please refer to the Configuration File for detailed information.

📦 Installation

The server is now available as an NPM package. You can install it using the following command:

npm install @fanyangmeng/ghost-mcp

📚 Documentation

Configuration

Environment Variables

The following environment variables are required to run the server:

💻 Usage Examples

Basic Usage

// Add the following to claude_desktop.yaml
ghost-mcp-server:
  enabled: true
  endpoint: http://localhost:5000

Advanced Usage

Article Management

interface GhostArticleToolParams {
  title: string;
  content: string;
  authorId?: string;
  publishedAt?: string;
}

async function createGhostArticle(params: GhostArticleToolParams): Promise<void> {
  // Create article logic
}

async function updateGhostArticle(articleId: string, params: Omit<GhostArticleToolParams, 'title'>): Promise<void> {
  // Update article logic
}

async function deleteGhostArticle(articleId: string): Promise<void> {
  // Delete article logic
}

User Management

interface GhostUserToolParams {
  email: string;
  password: string;
  username?: string;
}

async function createUser(params: GhostUserToolParams): Promise<string> {
  // Create user logic, returns user ID
}

async function updateUser(userId: string, params: Omit<GhostUserToolParams, 'email'>): Promise<void> {
  // Update user logic
}

Error Handling

The Ghost MCP Server uses a custom GhostError exception to handle API communication errors and processing issues, ensuring clear and detailed error messages for easy troubleshooting.

Contribution Guidelines

1. Fork the repository.
2. Create a feature branch.
3. Commit your changes.
4. Create a pull request.

📄 License

This project is licensed under the MIT license.