Skip to content

Commit 047bcbb

Browse files
authored
Merge pull request #14 from railsware/nika-is-nika-patch-1
Update README.md
2 parents 25e8662 + ca2c8bd commit 047bcbb

File tree

1 file changed

+34
-8
lines changed

1 file changed

+34
-8
lines changed

README.md

Lines changed: 34 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,35 @@
22

33
# Coupler.io official MCP server
44
The Coupler.io MCP Server is a Model Context Protocol (MCP) server that provides seamless integration with Coupler.io APIs.
5+
With Coupler.io MCP Server, you can analyze multi-channel marketing, financial, sales, e-commerce, and other business data within Claude by connecting to your Coupler.io data flows — query marketing, sales, and finance metrics from hundreds of sources. Fetch and transform raw data from platforms like Google Ads, Facebook, HubSpot, and Salesforce into actionable intelligence for smarter, faster decision-making with accurate, up-to-date business information.
56

6-
**⚠️ Alpha Software Warning**
7-
This repo contains early alpha software under active development. Features are incomplete and subject to breaking changes.
87

98
## Use Cases
10-
- Extracting and analyzing data from Coupler.io data flows.
9+
Get data from your Coupler.io data flows and ask your AI tool questions about it, like you would ask your fellow data analyst:
10+
11+
### Marketing:
12+
1. What's our overall customer acquisition cost across all paid channels this quarter compared to last quarter? I need this for the board meeting.
13+
2. Show me the ROI breakdown by marketing channel for the past 6 months. I need to reallocate our annual budget.
14+
3. Which campaigns are contributing most to our pipeline revenue? I want to double down on what's working.
15+
16+
### Sales:
17+
1. Can you pull the sales pipeline report for this month? I need to see how many deals are in each stage and the total value at each stage.
18+
2. What are our conversion rates from lead to opportunity and from opportunity to closed-won for the last quarter? How do they compare to our targets?
19+
3. How many deals are expected to close this month based on their probability scores? What's our forecasted revenue vs our monthly target?
20+
21+
### Finance:
22+
1. Check the profit for this quarter, compare it to last quarter, and provide a breakdown by department.
23+
2. Could you provide a cash flow report for the last 30 days, including all incoming and outgoing transactions?
24+
3. Share the current accounts receivable status and tell me how many overdue invoices we have and which customers owe the most.
1125

1226
## Prerequisites
1327
1. Install [Docker](https://www.docker.com/) to run the server in a container.
1428
2. Make sure Docker is running.
15-
3. Get a [Coupler.io Personal Access Token](https://app.coupler.io/app/ai_features)
29+
3. Get a [Coupler.io Personal Access Token](https://app.coupler.io/app/mcp/).
30+
31+
**OR**
32+
33+
Build a .dxt file using the command below and use it to install the local MCP.
1634

1735
## Running the server
1836
### Claude Desktop
@@ -39,18 +57,26 @@ This repo contains early alpha software under active development. Features are i
3957
```
4058

4159
NOTE: `"--pull=always"` will ensure you always have the latest image by pulling it from the registry.
42-
Remove this line, if you're offline or if you specifically want to use the image you've already pulled previously.
60+
Remove this line if you're offline or if you specifically want to use the image you've already pulled previously.
4361

4462
## Tools
4563
### Data flows
46-
- **get-data** - Gets the result of a data flow run as a SQLite file and executes a read-only query on it. Currently, only data flows built from a dashboard or dataset template are supported.
64+
- **get-data** - Gets the result of a data flow run as a SQLite file and executes a read-only query on it. To get the data from a Coupler.io data flow, you need the data flow to have an AI destination.
4765
- `dataflowId`: Data flow ID (`string`, **required**)
4866
- `executionId`: Data flow run ID (`string`, **required**)
4967
- `query`: Query to run on the data flow SQLite file (`string`, **required**)
5068

5169
- **get-schema** - Gets the data flow schema file. Currently, only data flows built from a dashboard or dataset template are supported.
5270
- `dataflowId`: Data flow ID (`string`, **required**)
5371
- `executionId`: Data flow run ID (`string`, **required**)
72+
73+
- **list-dataflows** – Gets the list of data flows that have an AI destination.
74+
- `dataflowId`: Data flow ID (`string`, **required**)
75+
- `executionId`: Data flow run ID (`string`, **required**)
76+
77+
- **get-dataflow** – Gets the metadata about the data flow, such as sources, data connections, last successfull execution, and error details (if present).
78+
- `dataflowId`: Data flow ID (`string`, **required**)
79+
- `executionId`: Data flow run ID (`string`, **required**)
5480

5581
## Development
5682

@@ -97,7 +123,7 @@ tail -f log/development.log | npx pino-pretty
97123
You can also optionally capture STDIO messages in the log file by setting `LOG_STDIO=1` when running the server.
98124
If you're debugging a containerized server, you'd likely want to mount a dir at `/app/log` to be able to access the logs it generates.
99125

100-
### Working with development Docker image
126+
### Working with the development Docker image
101127
Build Docker image for development:
102128
```shell
103129
bin/build_image
@@ -159,7 +185,7 @@ npx @modelcontextprotocol/inspector --cli npm run dev --method tools/call --tool
159185
```
160186

161187
### Testing the Docker image against Coupler.io staging
162-
We build and publish a Docker image with of our MCP server, tagged `edge`, on every push to the `main` branch.
188+
We build and publish a Docker image of our MCP server, tagged `edge`, on every push to the `main` branch.
163189

164190
Configure Claude Desktop to run the Docker container against Coupler.io staging.
165191
Navigate to Settings > Developer > Edit Config.

0 commit comments

Comments
 (0)