Skip to content

Commit c181457

Browse files
authored
chore: README updates to make it simpler (#1)
1 parent 1afdff8 commit c181457

File tree

1 file changed

+27
-24
lines changed

1 file changed

+27
-24
lines changed

README.md

Lines changed: 27 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,44 @@
22

33
The Razorpay MCP Server is a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) server that provides seamless integration with Razorpay APIs, enabling advanced payment processing capabilities for developers and AI tools.
44

5-
## Use Cases
6-
Bring Razorpay to your agentic applications using Razorpay MCP Server.
5+
## Available Tools
76

7+
Currently, the Razorpay MCP Server provides the following tools:
8+
9+
| Tool | Description |
10+
|-----------------------|---------------------------------------|
11+
| `payment.fetch` | Fetch payment details |
12+
| `payment_link.create` | Creates a new payment link |
13+
| `payment_link.fetch` | Fetch details of a payment link |
14+
| `order.create` | Creates an order |
15+
| `order.fetch` | Fetch order details |
16+
17+
18+
## Use Cases
19+
- Workflow Automation: Automate your day to day workflow using Razorpay MCP Server.
820
- Agentic Applications: Building AI powered tools that interact with Razorpay's payment ecosystem using this Razorpay MCP server.
9-
- Analytics Usecases: Fetching payment data from Razorpay for analysis or customer support.
10-
- Customer and Operational Usecases: You can bring Razorpay integration into your agentic customer and operational dashboards using Razorpay MCP server.
1121

1222
## Setup
1323

24+
### Prerequisites
25+
- Docker
26+
- Golang (Go)
27+
- Git
28+
1429
To run the Razorpay MCP server, use one of the following methods:
1530

1631
### Using Docker (Recommended)
1732

33+
You need to clone the Github repo and build the image for Razorpay MCP Server using `docker`. Do make sure `docker` is installed and running in your system.
34+
1835
```bash
1936
# Run the server
37+
git clone https://github.com/razorpay/razorpay-mcp-server.git
38+
cd razorpay-mcp-server
2039
docker build -t razorpay-mcp-server:latest .
2140
```
2241

23-
Replace `your_key_id` and `your_key_secret` with your actual Razorpay API credentials.
42+
Post this razorpay-mcp-server:latest docker image would be ready in your system.
2443

2544
### Build from source
2645

@@ -31,13 +50,9 @@ cd razorpay-mcp-server
3150

3251
# Build the binary
3352
go build -o razorpay-mcp-server ./cmd/razorpay-mcp-server
34-
35-
# Run the server
36-
RAZORPAY_KEY_ID=your_key_id RAZORPAY_KEY_SECRET=your_key_secret ./razorpay-mcp-server stdio
3753
```
3854

39-
## Usage with Razorpay Checkout
40-
Coming soon.
55+
Binary `razorpay-mcp-server` would be present in your system post this.
4156

4257
## Usage with Claude Desktop
4358

@@ -66,10 +81,10 @@ Add the following to your `claude_desktop_config.json`:
6681
}
6782
}
6883
```
69-
7084
Please replace the `your_razorpay_key_id` and `your_razorpay_key_secret` with your keys.
7185

72-
Learn about how to configure MCP servers in Claude desktop: [Link](https://modelcontextprotocol.io/quickstart/user)
86+
- Learn about how to configure MCP servers in Claude desktop: [Link](https://modelcontextprotocol.io/quickstart/user)
87+
- How to install Claude Desktop: [Link](https://claude.ai/download)
7388

7489
## Usage with VS Code
7590

@@ -117,18 +132,6 @@ Add the following to your VS Code settings (JSON):
117132

118133
Learn more about MCP servers in VS Code's [agent mode documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers).
119134

120-
## Available Tools
121-
122-
Currently, the Razorpay MCP Server provides the following tools:
123-
124-
| Tool | Description |
125-
|-----------------------|---------------------------------------|
126-
| `payment.fetch` | Fetch payment details |
127-
| `payment_link.create` | Creates a new payment link |
128-
| `payment_link.fetch` | Fetch details of a payment link |
129-
| `order.create` | Creates an order |
130-
| `order.fetch` | Fetch order details |
131-
132135
## Configuration
133136

134137
The server requires the following configuration:

0 commit comments

Comments
 (0)