Skip to content

docs: restructure dashboard MCP quick start by client type #136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nishant49-code merged 1 commit into from
Jun 3, 2026
Merged

docs: restructure dashboard MCP quick start by client type #136

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 27 additions & 12 deletions juspay_dashboard_mcp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,18 @@ A Model Context Protocol (MCP) server for Juspay's Merchant Dashboard APIs. This
https://mcp.juspay.in/dashboard/juspay-dashboard-stream
```

### Claude Code (OAuth Flow)
### Web & Desktop Apps (Claude, ChatGPT, Codex, Cursor)

1. Open **Settings → Connectors / MCP Servers / Tools & MCP**
2. Click **Create** / **Add** / **New MCP Server**
3. Paste the server URL: `https://mcp.juspay.in/dashboard/juspay-dashboard-stream`
4. Authenticate via OAuth when prompted

> ChatGPT requires Developer Mode enabled (Settings → Developer Mode) and a Plus/Pro/Team/Enterprise plan.

### CLI

#### Claude Code

```bash
# Step 1: Add the MCP server
Expand All @@ -29,7 +40,7 @@ Inside Claude Code:
3. Click to authenticate — your browser will open to Juspay Portal
4. Sign in with your Juspay credentials

### OpenAI Codex CLI (OAuth Flow)
#### Codex CLI

```bash
# Step 1: Add the MCP server
Expand All @@ -41,9 +52,9 @@ codex mcp add juspay-dashboard --url https://mcp.juspay.in/dashboard/juspay-dash
codex
```

### Cursor (OAuth Flow)
#### Cursor

Add to `~/.cursor/mcp.json` (global) or `.cursor/mcp.json` (project):
Step 1: Add to `~/.cursor/mcp.json` (global) or `.cursor/mcp.json` (project):

```json
{
Expand All @@ -55,15 +66,19 @@ Add to `~/.cursor/mcp.json` (global) or `.cursor/mcp.json` (project):
}
```

Step 2: Enable, authenticate, and start:

```bash
agent mcp enable juspay-dashboard
agent mcp login juspay-dashboard
agent
```

### VS Code (OAuth Flow)
### IDEs (VS Code, Windsurf)

#### VS Code

Add to `.vscode/mcp.json` (project) or your user-level `mcp.json`:
Add to `.vscode/mcp.json` (project) or your user-level `mcp.json`, then open Agent mode in your AI extension and authenticate:

```json
{
Expand All @@ -76,11 +91,9 @@ Add to `.vscode/mcp.json` (project) or your user-level `mcp.json`:
}
```

Open Copilot Chat, switch to **Agent** mode, and authenticate when prompted.

### Windsurf (OAuth Flow)
#### Windsurf

Add to `~/.codeium/windsurf/mcp_config.json`:
Open the MCP Marketplace in the Cascade panel and add the server URL, or add to `~/.codeium/windsurf/mcp_config.json` directly:

```json
{
Expand All @@ -106,8 +119,10 @@ For clients that don't support remote HTTP transport, use the Docker image via S
"--pull=always",
"--rm",
"-i",
"-e", "JUSPAY_WEB_LOGIN_TOKEN",
"-e", "JUSPAY_ENV",
"-e",
"JUSPAY_WEB_LOGIN_TOKEN",
"-e",
"JUSPAY_ENV",
"juspaydotin/juspay-dashboard-mcp:latest"
],
"env": {
Expand Down
Loading