Skip to content

Commit 7444bb9

Browse files
committed
fix: make credential placeholders more obvious in documentation
- Change 'admin' to 'YOUR_USERNAME_HERE' - Change 'dev-password' to 'YOUR_PASSWORD_HERE' - Change 'your-production-token' to 'YOUR_PRODUCTION_TOKEN_HERE' - Change all credential examples to use CAPS_WITH_HERE suffix - Resolve README.md conflict from main merge
1 parent 4611b98 commit 7444bb9

2 files changed

Lines changed: 19 additions & 19 deletions

File tree

PLUGIN.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,15 @@ Copy this template to your settings file and uncomment/configure the variables y
3333
// Authentication - choose ONE method:
3434

3535
// Option 1: Bearer Token
36-
// "REST_MCP_AUTH_BEARER": "your-bearer-token",
36+
// "REST_MCP_AUTH_BEARER": "YOUR_BEARER_TOKEN_HERE",
3737

3838
// Option 2: Basic Auth
39-
// "REST_MCP_AUTH_USERNAME": "your-username",
40-
// "REST_MCP_AUTH_PASSWORD": "your-password",
39+
// "REST_MCP_AUTH_USERNAME": "YOUR_USERNAME_HERE",
40+
// "REST_MCP_AUTH_PASSWORD": "YOUR_PASSWORD_HERE",
4141

4242
// Option 3: API Key
4343
// "REST_MCP_APIKEY_HEADER": "X-API-Key",
44-
// "REST_MCP_APIKEY_VALUE": "your-api-key",
44+
// "REST_MCP_APIKEY_VALUE": "YOUR_API_KEY_HERE",
4545

4646
// Optional settings:
4747
// "REST_MCP_SSL_VERIFY": "true",
@@ -62,7 +62,7 @@ Set environment variables before starting Claude Code:
6262
```bash
6363
# In your ~/.bashrc or ~/.zshrc
6464
export REST_MCP_BASE_URL="https://your-api.com"
65-
export REST_MCP_AUTH_BEARER="your-bearer-token"
65+
export REST_MCP_AUTH_BEARER="YOUR_BEARER_TOKEN_HERE"
6666

6767
# Or for one session
6868
REST_MCP_BASE_URL="http://localhost:3000" claude
@@ -80,15 +80,15 @@ Edit `.claude/settings.json` in your project and paste this template:
8080
// Authentication - choose ONE method:
8181

8282
// Option 1: Bearer Token
83-
// "REST_MCP_AUTH_BEARER": "your-bearer-token",
83+
// "REST_MCP_AUTH_BEARER": "YOUR_BEARER_TOKEN_HERE",
8484

8585
// Option 2: Basic Auth
86-
"REST_MCP_AUTH_USERNAME": "admin",
87-
"REST_MCP_AUTH_PASSWORD": "dev-password",
86+
"REST_MCP_AUTH_USERNAME": "YOUR_USERNAME_HERE",
87+
"REST_MCP_AUTH_PASSWORD": "YOUR_PASSWORD_HERE",
8888

8989
// Option 3: API Key
9090
// "REST_MCP_APIKEY_HEADER": "X-API-Key",
91-
// "REST_MCP_APIKEY_VALUE": "your-api-key",
91+
// "REST_MCP_APIKEY_VALUE": "YOUR_API_KEY_HERE",
9292

9393
// Optional settings:
9494
// "REST_MCP_SSL_VERIFY": "false",
@@ -109,15 +109,15 @@ Edit `~/.claude/settings.json` and paste this template:
109109
// Authentication - choose ONE method:
110110

111111
// Option 1: Bearer Token
112-
"REST_MCP_AUTH_BEARER": "your-production-token",
112+
"REST_MCP_AUTH_BEARER": "YOUR_PRODUCTION_TOKEN_HERE",
113113

114114
// Option 2: Basic Auth
115-
// "REST_MCP_AUTH_USERNAME": "username",
116-
// "REST_MCP_AUTH_PASSWORD": "password",
115+
// "REST_MCP_AUTH_USERNAME": "YOUR_USERNAME_HERE",
116+
// "REST_MCP_AUTH_PASSWORD": "YOUR_PASSWORD_HERE",
117117

118118
// Option 3: API Key
119119
// "REST_MCP_APIKEY_HEADER": "X-API-Key",
120-
// "REST_MCP_APIKEY_VALUE": "your-key",
120+
// "REST_MCP_APIKEY_VALUE": "YOUR_API_KEY_HERE",
121121

122122
// Optional settings:
123123
"REST_MCP_SSL_VERIFY": "true",
@@ -134,8 +134,8 @@ All variables use the `REST_MCP_` prefix to avoid naming conflicts.
134134
|----------|-------------------|-------------|---------|
135135
| `REST_MCP_BASE_URL` | `REST_BASE_URL` | Base URL for API requests | `https://api.example.com` |
136136
| `REST_MCP_AUTH_BEARER` | `AUTH_BEARER` | Bearer token authentication | None |
137-
| `REST_MCP_AUTH_USERNAME` | `AUTH_BASIC_USERNAME` | Basic auth username | None |
138-
| `REST_MCP_AUTH_PASSWORD` | `AUTH_BASIC_PASSWORD` | Basic auth password | None |
137+
| `REST_MCP_AUTH_USERNAME` | `AUTH_BASIC_USERNAME` | Basic auth YOUR_USERNAME_HERE | None |
138+
| `REST_MCP_AUTH_PASSWORD` | `AUTH_BASIC_PASSWORD` | Basic auth YOUR_PASSWORD_HERE | None |
139139
| `REST_MCP_APIKEY_HEADER` | `AUTH_APIKEY_HEADER_NAME` | API key header name | None |
140140
| `REST_MCP_APIKEY_VALUE` | `AUTH_APIKEY_VALUE` | API key value | None |
141141
| `REST_MCP_SSL_VERIFY` | `REST_ENABLE_SSL_VERIFY` | Enable SSL verification | `true` |
@@ -161,7 +161,7 @@ claude
161161

162162
# Ask Claude to test endpoints
163163
> Test the GET /users endpoint
164-
> Make a POST to /auth/login with email and password
164+
> Make a POST to /auth/login with email and YOUR_PASSWORD_HERE
165165
```
166166

167167
### Testing a Production API
@@ -190,7 +190,7 @@ claude
190190
```bash
191191
export REST_MCP_BASE_URL="https://api.example.com"
192192
export REST_MCP_APIKEY_HEADER="X-API-Key"
193-
export REST_MCP_APIKEY_VALUE="your-api-key-here"
193+
export REST_MCP_APIKEY_VALUE="YOUR_API_KEY_HERE-here"
194194

195195
claude
196196
```
@@ -211,7 +211,7 @@ Once installed and configured, ask Claude to test REST endpoints:
211211

212212
```
213213
Test the GET /users endpoint
214-
Make a POST request to /auth/login with {"email": "test@example.com", "password": "secret"}
214+
Make a POST request to /auth/login with {"email": "test@example.com", "YOUR_PASSWORD_HERE": "secret"}
215215
What does the /api/status endpoint return?
216216
Check if the /health endpoint is responding
217217
Send a PUT request to /users/123 to update the user

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
33
[![NPM Package](https://img.shields.io/npm/v/dkmaker-mcp-rest-api.svg)](https://www.npmjs.com/package/dkmaker-mcp-rest-api)
44

5-
A TypeScript-based MCP server that enables testing of REST APIs through Claude, Cline and other MCP clients. This tool allows you to test and interact with any REST API endpoints directly from your development environment.
5+
A TypeScript-based MCP server that enables testing of REST APIs through Claude Code, Cline, and other MCP clients. This tool allows you to test and interact with any REST API endpoints directly from your development environment.
66

77
<a href="https://glama.ai/mcp/servers/izr2sp4rqo">
88
<img width="380" height="200" src="https://glama.ai/mcp/servers/izr2sp4rqo/badge?refresh=1234" />

0 commit comments

Comments
 (0)