Postscript MCP Server

🚀 Postscript MCP Server

A MCP server for interacting with the Postscript SMS marketing platform API.

🚀 Quick Start

This MCP server enables seamless interaction with the Postscript SMS marketing platform API. Below are the steps to get started:

📦 Installation

1. Install dependencies:

   npm install
   

2. Configure your API key:
   • Create a .env file in the project root directory.
   • Add your Postscript API key: POSTSCRIPT_API_KEY=your_api_key_here
3. Run the server:

   npm run dev
   

4. Test with MCP Inspector:

   npm run inspect
   

✨ Features

This MCP server provides the following Postscript API capabilities:

• Shops: Retrieve information about your Postscript shops.
• Subscribers: Manage SMS subscribers (create, update, retrieve).
• Campaigns: Create and retrieve SMS marketing campaigns.
• Messages: Send direct messages to subscribers.
• Keywords: Retrieve SMS keywords.

💻 Usage Examples

Basic Usage

Here are some basic usage examples of the available tools:

// Get all Postscript shops
const shops = await get_shops();

// Get a specific shop by ID
const shop = await get_shop(shopId);

// Get subscribers of a shop
const subscribers = await get_subscribers(shopId);

// Get a specific subscriber by ID
const subscriber = await get_subscriber(subscriberId);

// Create a new subscriber
const newSubscriber = await create_subscriber(shopId, subscriberData);

// Update an existing subscriber
const updatedSubscriber = await update_subscriber(shopId, subscriberId, updatedData);

// Get all campaigns of a shop
const campaigns = await get_campaigns(shopId);

// Create a new marketing campaign
const newCampaign = await create_campaign(shopId, campaignData);

// Send a direct message to a specific subscriber
const message = await send_message(shopId, subscriberId, messageData);

// Get keywords of a shop
const keywords = await get_keywords(shopId);

📚 Documentation

Available Tools

• get_shops: Get all Postscript shops.
• get_shop: Get a specific shop by ID.
• get_subscribers: Get subscribers of a shop.
• get_subscriber: Get a specific subscriber by ID.
• create_subscriber: Create a new subscriber.
• update_subscriber: Update an existing subscriber's information.
• get_campaigns: Get all campaigns of a shop.
• create_campaign: Create a new marketing campaign.
• send_message: Send a direct message to a specific subscriber.
• get_keywords: Get keywords of a shop.

Available Resources

• postscript://shops: List all shops.
• postscript://shops/{shopId}: Get a specific shop by ID.
• postscript://shops/{shopId}/subscribers: Get all subscribers of a shop.
• postscript://shops/{shopId}/subscribers/{subscriberId}: Get a specific subscriber by ID.
• postscript://shops/{shopId}/campaigns: Get all campaigns of a shop.

API Documentation

For more information about the Postscript API, please refer to:

• Quick Start Guide
• API Reference Documentation