Skip to content

Commit c37cae5

Browse files
chore: update README
1 parent 5b000e1 commit c37cae5

1 file changed

Lines changed: 22 additions & 36 deletions

File tree

README.md

Lines changed: 22 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,7 @@ A [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server that e
77
88
## Quick Start
99

10-
<!-- TODO: Update once published to npm -->
11-
12-
```bash
13-
# Via npx (coming soon)
14-
npx paystack-mcp start
15-
16-
# With environment configuration
17-
PAYSTACK_TEST_SECRET_KEY=sk_test_... npx paystack-mcp start
18-
```
19-
20-
For now, clone and build locally:
10+
Clone the repo and build locally:
2111

2212
```bash
2313
git clone https://github.com/PaystackOSS/paystack-mcp-server.git
@@ -36,11 +26,9 @@ Then configure your MCP client to use the built server (see [Client Integration]
3626

3727
## Configuration Options
3828

39-
| Environment Variable | Purpose | Default |
40-
| -------------------------- | ------------------------------------------------------ | ------------- |
41-
| `PAYSTACK_TEST_SECRET_KEY` | Your Paystack test secret key **(required)** ||
42-
| `NODE_ENV` | Environment mode (`development`, `production`, `test`) | `development` |
43-
| `LOG_LEVEL` | Logging verbosity (`debug`, `info`, `warn`, `error`) | `info` |
29+
| Environment Variable | Purpose |
30+
| -------------------------- | ------------------------------------------------------ |
31+
| `PAYSTACK_TEST_SECRET_KEY` | Your Paystack test secret key **(required)** |
4432

4533
> **Security note:** Only test keys (`sk_test_*`) are allowed. The server validates this at startup and will reject live keys.
4634
@@ -81,25 +69,7 @@ If you've cloned and built the server locally:
8169
> where node
8270
> ```
8371
>
84-
> On getting the path, it can be used as the value of the MCP Server command. e.g., `command: "path/to/installation/bin/node"`
85-
86-
### Using npm (coming soon)
87-
88-
<!-- TODO: Update once published -->
89-
90-
```json
91-
{
92-
"mcpServers": {
93-
"paystack": {
94-
"command": "npx",
95-
"args": ["paystack-mcp", "start"],
96-
"env": {
97-
"PAYSTACK_TEST_SECRET_KEY": "sk_test_..."
98-
}
99-
}
100-
}
101-
}
102-
```
72+
> Once you have the path, use it as the value of the MCP Server command in the JSON configuration. e.g., `command: "path/to/installation/bin/node"`
10373
10474
### Where to add this configuration
10575
@@ -121,6 +91,7 @@ The Paystack MCP Server exposes the **entire Paystack API** to AI assistants by
12191
| Tool | Description |
12292
| ------------------------ | ------------------------------------------------------------------ |
12393
| `get_paystack_operation` | Fetch operation details (method, path, parameters) by operation ID |
94+
| `get_paystack_operation_guided` | Infers the operation ID from prompt |
12495
| `make_paystack_request` | Execute a Paystack API request |
12596
12697
### Available Resources
@@ -131,13 +102,28 @@ The Paystack MCP Server exposes the **entire Paystack API** to AI assistants by
131102
132103
### Example
133104
134-
When you ask your AI assistant something like _"Get me the last 5 transactions"_, here's what happens behind the scenes:
105+
When you ask your AI assistant something like _"Get me the last 5 transactions on my Paystact integration"_, here's what happens behind the scenes:
135106
136107
1. The assistant calls `get_paystack_operation("transaction_list")` to look up the endpoint details
137108
2. It gets back the method (`GET`), path (`/transaction`), and available query parameters
138109
3. It then calls `make_paystack_request` with `{ method: "GET", path: "/transaction", data: { perPage: 5 } }`
139110
4. You get your transactions
140111
112+
### Prompt recommendation
113+
114+
To get the best results when using this MCP server, be specific in your prompts and always include "Paystack" in your requests. This helps the LLM quickly identify and use the appropriate Paystack tools.
115+
116+
**Good prompts:**
117+
- "Initialize a Paystack transaction for 50000 NGN"
118+
- "Create a customer with email user@example.com on my Paystack account"
119+
- "How can I send money with the Paystack API?"
120+
121+
**Less effective prompts:**
122+
- "List my transactions" (unclear which service to use)
123+
- "Charge a customer" (missing context about Paystack)
124+
125+
Being explicit ensures the LLM narrows down to the right tool quickly and reduces ambiguity.
126+
141127
## Development
142128
143129
### Run locally (without building)

0 commit comments

Comments
 (0)