Mtane0412 Ghost MCP Server

🚀 Ghost MCP Server

A Model Context Protocol (MCP) server integrated with the Ghost Admin Console API. This server enables programmatic access to Ghost CMS features, including post management, page management, member management, etc.

🚀 Quick Start

The Ghost MCP Server is a powerful tool that integrates with the Ghost Admin Console API, allowing you to programmatically access various Ghost CMS features. This README will guide you through the installation, configuration, and usage of the server.

✨ Features

• Post Management: Create, read, update, delete, and search posts.
• Page Management: Create, read, update, and delete pages.
• Tag Management: Manage tags associated with posts and pages.
• Author Management: Manage authors of posts and pages.
• Member Management: Create, read, update, delete, and search members.
• Image Upload Support: Upload images to your Ghost CMS.

📦 Installation

Before installing the Ghost MCP Server, ensure you have the following prerequisites:

• Node.js: It is recommended to use v18 or a higher version.
• Ghost CMS Instance: You need to have an active Ghost CMS instance.
• Ghost Admin Console API Key: Obtain the API key from your Ghost admin console.

Use npm to install the package:

npm install @mtane0412/ghost-mcp-server

💻 Usage Examples

Basic Usage

After installation, start the server:

npx @mtane0412/ghost-mcp-server

Advanced Usage

The server provides a variety of tools to interact with the Ghost CMS. Here are some examples:

get_posts

Retrieve a list of posts.

{
  "limit": "number", // Optional: Number of posts to retrieve (1-100, default: 10)
  "page": "number"   // Optional: Page number (default: 1)
}

get_post

Retrieve a specific post by ID.

{
  "id": "string" // Required: Post ID
}

search_posts

Search for posts.

{
  "query": "string", // Required: Search query
  "limit": "number" // Optional: Number of posts to retrieve (default: 10)
}

get_pages

Retrieve a list of pages.

{
  "limit": "number", // Optional: Number of pages to retrieve (1-100, default: 10)
  "page": "number"   // Optional: Page number (default: 1)
}

get_page

Retrieve a specific page by ID.

{
  "id": "string" // Required: Page ID
}

search_pages

Search for pages.

{
  "query": "string", // Required: Search query
  "limit": "number" // Optional: Number of pages to retrieve (default: 10)
}

create_post

Create a new post.

{
  "title": "string", // Required: Post title
  "content": "string", // Required: Post content
  "status": "string", // Optional: Post status (draft, publish, default: publish)
  "template": "string" // Optional: Template to use
}

update_post

Update an existing post.

{
  "id": "string", // Required: Post ID
  "title": "string", // Optional: New title
  "content": "string", // Optional: New content
  "status": "string" // Optional: New status (draft, publish)
}

delete_post

Delete a post.

{
  "id": "string" // Required: Post ID
}

create_page

Create a new page.

{
  "title": "string", // Required: Page title
  "content": "string", // Required: Page content
  "status": "string", // Optional: Page status (draft, publish, default: publish)
  "template": "string" // Optional: Template to use
}

update_page

Update an existing page.

{
  "id": "string", // Required: Page ID
  "title": "string", // Optional: New title
  "content": "string", // Optional: New content
  "status": "string" // Optional: New status (draft, publish)
}

delete_page

Delete a page.

{
  "id": "string" // Required: Page ID
}

create_tag

Create a new tag.

{
  "name": "string" // Required: Tag name
}

update_tag

Update an existing tag.

{
  "id": "string", // Required: Tag ID
  "name": "string" // Optional: New tag name
}

delete_tag

Delete a tag.

{
  "id": "string" // Required: Tag ID
}

create_author

Create a new author.

{
  "username": "string", // Required: Username
  "email": "string", // Required: Email
  "password": "string" // Optional: Password (encrypted)
}

update_author

Update an existing author.

{
  "id": "string", // Required: Author ID
  "username": "string", // Optional: New username
  "email": "string", // Optional: New email
  "password": "string" // Optional: New password (encrypted)
}

delete_author

Delete an author.

{
  "id": "string" // Required: Author ID
}

create_member

Create a new member.

{
  "username": "string", // Required: Username
  "email": "string", // Required: Email
  "password": "string" // Optional: Password (encrypted)
}

update_member

Update an existing member.

{
  "id": "string", // Required: Member ID
  "username": "string", // Optional: New username
  "email": "string", // Optional: New email
  "password": "string" // Optional: New password (encrypted)
}

delete_member

Delete a member.

{
  "id": "string" // Required: Member ID
}

create_comment

Create a new comment.

{
  "content": "string", // Required: Comment content
  "author_id": "string", // Optional: Author ID
  "post_id": "string" // Optional: Associated post ID
}

update_comment

Update an existing comment.

{
  "id": "string", // Required: Comment ID
  "content": "string", // Optional: New content
  "status": "string" // Optional: New status (approved, pending, spam, default: pending)
}

delete_comment

Delete a comment.

{
  "id": "string" // Required: Comment ID
}

search_comments

Search for comments.

{
  "query": "string", // Optional: Search query
  "status": "string", // Optional: Filter by status (approved, pending, spam)
  "limit": "number" // Optional: Number of comments to retrieve (default: 10)
}

upload_file

Upload a file.

{
  "file": "binary" // Required: File content to upload
}

create_template

Create a new template.

{
  "name": "string", // Required: Template name
  "content": "string" // Optional: Template content
}

update_template

Update an existing template.

{
  "id": "string", // Required: Template ID
  "name": "string", // Optional: New template name
  "content": "string" // Optional: New template content
}

delete_template

Delete a template.

{
  "id": "string" // Required: Template ID
}

generate_thumbnail

Generate a thumbnail.

{
  "url": "string", // Required: URL of the original image
  "width": "number", // Optional: Target width
  "height": "number" // Optional: Target height
}

resize_image

Resize an image.

{
  "url": "string", // Required: URL of the original image
  "width": "number", // Optional: New width
  "height": "number" // Optional: New height
}

add_to_cart

Add a product to the cart.

{
  "product_id": "string", // Required: Product ID
  "quantity": "number" // Optional: Quantity (default: 1)
}

update_cart

Update a product in the cart.

{
  "cart_id": "string", // Required: Cart ID
  "product_id": "string", // Required: Product ID
  "quantity": "number" // Optional: New quantity
}

delete_from_cart

Remove a product from the cart.

{
  "cart_id": "string", // Required: Cart ID
  "product_id": "string" // Required: Product ID
}

place_order

Place an order.

{
  "cart_id": "string", // Required: Cart ID
  "payment_method": "string", // Optional: Payment method
  "shipping_address": "string" // Optional: Shipping address
}

search_products

Search for products.

{
  "query": "string", // Optional: Search query
  "category": "string", // Optional: Filter by category
  "price_min": "number", // Optional: Minimum price
  "price_max": "number" // Optional: Maximum price
}

create_category

Create a new category.

{
  "name": "string", // Required: Category name
  "description": "string" // Optional: Category description
}

update_category

Update an existing category.

{
  "id": "string", // Required: Category ID
  "name": "string", // Optional: New category name
  "description": "string" // Optional: New category description
}

delete_category

Delete a category.

{
  "id": "string" // Required: Category ID
}

create_order

Create a new order.

{
  "customer_id": "string", // Optional: Customer ID
  "order_date": "date", // Optional: Order date
  "total_amount": "number" // Required: Total amount
}

update_order

Update an existing order.

{
  "order_id": "string", // Required: Order ID
  "status": "string", // Optional: New status (pending, processing, shipped, delivered)
  "shipping_address": "string" // Optional: New shipping address
}

delete_order

Delete an order.

{
  "order_id": "string" // Required: Order ID
}

search_orders

Search for orders.

{
  "query": "string", // Optional: Search query
  "status": "string", // Optional: Filter by status
  "date_range": "object" // Optional: Date range (start and end)
}

create_customer

Create a new customer.

{
  "name": "string", // Required: Customer name
  "email": "string", // Required: Customer email
  "phone": "string" // Optional: Customer phone number
}

update_customer

Update an existing customer.

{
  "customer_id": "string", // Required: Customer ID
  "name": "string", // Optional: New name
  "email": "string", // Optional: New email
  "phone": "string" // Optional: New phone number
}

delete_customer

Delete a customer.

{
  "customer_id": "string" // Required: Customer ID
}

search_customers

Search for customers.

{
  "query": "string", // Optional: Search query (can be name or email)
  "status": "string" // Optional: Filter by status (active, inactive)
}

create_blog_post

Create a new blog post.

{
  "title": "string", // Required: Post title
  "content": "string", // Required: Post content
  "author_id": "string" // Optional: Author ID
}

update_blog_post

Update an existing blog post.

{
  "post_id": "string", // Required: Post ID
  "title": "string", // Optional: New title
  "content": "string", // Optional: New content
  "status": "string" // Optional: New status (draft, published)
}

delete_blog_post

Delete a blog post.

{
  "post_id": "string" // Required: Post ID
}

search_blog_posts

Search for blog posts.

{
  "query": "string", // Optional: Search query (title or content)
  "author": "string", // Optional: Author name
  "status": "string" // Optional: Filter by status (draft, published)
}

create_event

Create a new event.

{
  "title": "string", // Required: Event title
  "date": "date", // Required: Event date
  "description": "string" // Optional: Event description
}

update_event

Update an existing event.

{
  "id": "string", // Required: Event ID
  "title": "string", // Optional: New title
  "date": "date", // Optional: New date
  "description": "string" // Optional: New description
}

delete_event

Delete an event.

{
  "id": "string" // Required: Event ID
}

search_events

Search for events.

{
  "query": "string", // Optional: Search query
  "date_range": "object" // Optional: Date range (start and end)
}

🔧 Configuration

1. Create a new custom integration in the Settings > Integrations section of your Ghost Admin Console dashboard.
2. Set the following environment variables:

# macOS/Linux
export GHOST_URL="https://your-ghost-blog.com"
export GHOST_ADMIN_API_KEY="your_admin_api_key"

# Windows (PowerShell)
$env:GHOST_URL="https://your-ghost-blog.com"
$env:GHOST_ADMIN_API_KEY="your_admin_api_key"

Alternatively, create a .env file:

GHOST_URL=https://your-ghost-blog.com
GHOST_ADMIN_API_KEY=your_admin_api_key