Skip to content

Commit 7b0b7b3

Browse files
committed
Added badge and npx instructions
1 parent 7eeb1d5 commit 7b0b7b3

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

README.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,27 @@
11
# Mailchimp MCP Server
22

3+
[![npm version](https://img.shields.io/npm/v/@agentx-ai/mailchimp-mcp-server)](https://www.npmjs.com/package/@agentx-ai/mailchimp-mcp-server)
4+
35
A Model Context Protocol (MCP) server that provides read-only access to Mailchimp's Marketing API for comprehensive email marketing data retrieval.
46

7+
## Usage
8+
9+
The server can be used with any MCP client. Configure your client to use:
10+
11+
```json
12+
{
13+
"mcpServers": {
14+
"mailchimp": {
15+
"command": "npx",
16+
"args": ["@agentx-ai/mailchimp-mcp-server"],
17+
"env": {
18+
"MAILCHIMP_API_KEY": "your-api-key-here"
19+
}
20+
}
21+
}
22+
}
23+
```
24+
525
## Features
626

727
This MCP server supports the following Mailchimp Marketing API endpoints (read-only operations):
@@ -94,7 +114,7 @@ This MCP server supports the following Mailchimp Marketing API endpoints (read-o
94114
- **List Merge Fields** - Get all merge fields in a specific list
95115
- **Get Merge Field** - Retrieve details of a specific merge field
96116

97-
## Installation
117+
## Local Installation
98118

99119
1. Clone this repository
100120
2. Install dependencies:
@@ -106,7 +126,7 @@ This MCP server supports the following Mailchimp Marketing API endpoints (read-o
106126
npm run build
107127
```
108128

109-
## Configuration
129+
### Configuration
110130

111131
Set the following environment variable:
112132

@@ -116,26 +136,6 @@ MAILCHIMP_API_KEY=your-mailchimp-api-key-here
116136

117137
Your Mailchimp API key should include the data center suffix (e.g., `xxxxxxxxxxxxxxxx-us1`).
118138

119-
## Usage
120-
121-
### As an MCP Server
122-
123-
The server can be used with any MCP client. Configure your client to use:
124-
125-
```json
126-
{
127-
"mcpServers": {
128-
"mailchimp": {
129-
"command": "node",
130-
"args": ["path/to/mailchimp-mcp/build/index.js"],
131-
"env": {
132-
"MAILCHIMP_API_KEY": "your-api-key-here"
133-
}
134-
}
135-
}
136-
}
137-
```
138-
139139
### Available Tools
140140

141141
#### Automation Management

0 commit comments

Comments
 (0)