Skip to content

Commit 0cf179a

Browse files
committed
Enhance README and index.ts with detailed querying capabilities, validation, and examples for Plausible Analytics MCP server
1 parent a95dfff commit 0cf179a

2 files changed

Lines changed: 582 additions & 36 deletions

File tree

README.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,94 @@ Add to your Claude Desktop configuration file:
103103

104104
Once configured, the MCP server provides four main tools:
105105

106+
## Getting Started
107+
108+
This MCP server lets you query Plausible Analytics for any site you own, directly from VS Code, Claude Desktop, or any MCP-compatible client. You can:
109+
- Get traffic, engagement, and conversion stats for your site
110+
- Break down analytics by page, device, country, source, and more
111+
- Run advanced filters and time-based queries
112+
- Automate reporting and SEO analysis
113+
114+
### Quick Setup
115+
1. Get your Plausible API key from https://plausible.io/settings/api-keys
116+
2. Set up your `.env` file or VS Code/Claude config (see below)
117+
3. Start the MCP server:
118+
```bash
119+
node build/index.js
120+
```
121+
4. Connect with your MCP client and start querying!
122+
123+
## Example Queries
124+
125+
### Get traffic stats for your site
126+
```json
127+
{
128+
"site_id": "alexop.dev",
129+
"metrics": ["visitors", "pageviews", "bounce_rate"],
130+
"date_range": "30d"
131+
}
132+
```
133+
134+
### See top countries and devices
135+
```json
136+
{
137+
"site_id": "alexop.dev",
138+
"metrics": ["visitors"],
139+
"date_range": "30d",
140+
"dimensions": ["visit:country_name", "visit:device"]
141+
}
142+
```
143+
144+
### Analyze traffic sources and campaigns
145+
```json
146+
{
147+
"site_id": "alexop.dev",
148+
"metrics": ["visitors"],
149+
"date_range": "30d",
150+
"dimensions": ["visit:source", "visit:utm_campaign"]
151+
}
152+
```
153+
154+
### Get hourly traffic trends
155+
```json
156+
{
157+
"site_id": "alexop.dev",
158+
"metrics": ["pageviews"],
159+
"date_range": "7d",
160+
"dimensions": ["time:hour"]
161+
}
162+
```
163+
164+
### Conversion rate by source (if goals set)
165+
```json
166+
{
167+
"site_id": "alexop.dev",
168+
"metrics": ["conversion_rate"],
169+
"date_range": "30d",
170+
"dimensions": ["visit:source"]
171+
}
172+
```
173+
174+
### Scroll depth per page
175+
```json
176+
{
177+
"site_id": "alexop.dev",
178+
"metrics": ["scroll_depth"],
179+
"date_range": "30d",
180+
"dimensions": ["event:page"]
181+
}
182+
```
183+
184+
## What insights can you get?
185+
- Top pages, landing and exit pages
186+
- Device, browser, and OS breakdowns
187+
- Geographic breakdowns (country, region, city)
188+
- Traffic sources and UTM campaign performance
189+
- Conversion rates and custom event tracking
190+
- Scroll depth and time on page
191+
- Hourly/daily/weekly/monthly traffic trends
192+
- Advanced filters and segments
193+
106194
### 1. plausible_query
107195
Full-featured querying with all Plausible API capabilities:
108196

0 commit comments

Comments
 (0)