Skip to content

Commit 6bca45b

Browse files
dkmakerdkmaker
committed
docs: add NPM package badge and link to README
1 parent 013e653 commit 6bca45b

File tree

1 file changed

+159
-158
lines changed

1 file changed

+159
-158
lines changed

‎README.md‎

Lines changed: 159 additions & 158 deletions
Original file line numberDiff line numberDiff line change
@@ -1,158 +1,159 @@
1-
# MCP REST API Tester
2-
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
3-
4-
A TypeScript-based MCP server that enables testing of REST APIs through Cline. This tool allows you to test and interact with any REST API endpoints directly from your development environment.
5-
6-
<a href="https://glama.ai/mcp/servers/izr2sp4rqo">
7-
<img width="380" height="200" src="https://glama.ai/mcp/servers/izr2sp4rqo/badge" />
8-
</a>
9-
10-
## Installation
11-
12-
1. Install the package globally:
13-
```bash
14-
npm install -g dkmaker-mcp-rest-api
15-
```
16-
17-
2. Add the server to your MCP configuration:
18-
19-
While these instructions are for Cline, the server should work with any MCP implementation. Configure based on your operating system:
20-
21-
### Windows
22-
⚠️ **IMPORTANT**: Due to a known issue with Windows path resolution ([issue #40](https://github.com/modelcontextprotocol/servers/issues/40)), you must use the full path instead of %APPDATA%.
23-
24-
Add to `C:\Users\<YourUsername>\AppData\Roaming\Code\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json`:
25-
```json
26-
{
27-
"mcpServers": {
28-
"rest": {
29-
"command": "node",
30-
"args": [
31-
"C:/Users/<YourUsername>/AppData/Roaming/npm/node_modules/dkmaker-mcp-rest-api/build/index.js"
32-
],
33-
"env": {
34-
"REST_BASE_URL": "https://api.example.com",
35-
// Basic Auth
36-
"AUTH_BASIC_USERNAME": "your-username",
37-
"AUTH_BASIC_PASSWORD": "your-password",
38-
// OR Bearer Token
39-
"AUTH_BEARER": "your-token",
40-
// OR API Key
41-
"AUTH_APIKEY_HEADER_NAME": "X-API-Key",
42-
"AUTH_APIKEY_VALUE": "your-api-key",
43-
// SSL Verification (enabled by default)
44-
"REST_ENABLE_SSL_VERIFY": "false" // Set to false to disable SSL verification for self-signed certificates
45-
}
46-
}
47-
}
48-
}
49-
```
50-
51-
### macOS
52-
Add to `~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json`:
53-
```json
54-
{
55-
"mcpServers": {
56-
"rest": {
57-
"command": "npx",
58-
"args": [
59-
"-y",
60-
"dkmaker-mcp-rest-api"
61-
],
62-
"env": {
63-
"REST_BASE_URL": "https://api.example.com",
64-
// Basic Auth
65-
"AUTH_BASIC_USERNAME": "your-username",
66-
"AUTH_BASIC_PASSWORD": "your-password",
67-
// OR Bearer Token
68-
"AUTH_BEARER": "your-token",
69-
// OR API Key
70-
"AUTH_APIKEY_HEADER_NAME": "X-API-Key",
71-
"AUTH_APIKEY_VALUE": "your-api-key",
72-
// SSL Verification (enabled by default)
73-
"REST_ENABLE_SSL_VERIFY": "false" // Set to false to disable SSL verification for self-signed certificates
74-
}
75-
}
76-
}
77-
}
78-
```
79-
80-
Note: Replace the environment variables with your actual values. Only configure one authentication method at a time:
81-
1. Basic Authentication (username/password)
82-
2. Bearer Token (if Basic Auth is not configured)
83-
3. API Key (if neither Basic Auth nor Bearer Token is configured)
84-
85-
## Features
86-
87-
- Test REST API endpoints with different HTTP methods
88-
- Support for GET, POST, PUT, and DELETE requests
89-
- Detailed response information including status, headers, and body
90-
- Custom header support
91-
- Request body handling for POST/PUT methods
92-
- SSL Certificate Verification:
93-
- Enabled by default for secure operation
94-
- Can be disabled for self-signed certificates or development environments
95-
- Control via REST_ENABLE_SSL_VERIFY environment variable
96-
- Multiple authentication methods:
97-
- Basic Authentication (username/password)
98-
- Bearer Token Authentication
99-
- API Key Authentication (custom header)
100-
101-
## Usage
102-
103-
Once installed and configured, you can use the REST API Tester through Cline to test your API endpoints:
104-
105-
```typescript
106-
// Test a GET endpoint
107-
{
108-
"method": "GET",
109-
"endpoint": "/users"
110-
}
111-
112-
// Test a POST endpoint with body
113-
{
114-
"method": "POST",
115-
"endpoint": "/users",
116-
"body": {
117-
"name": "John Doe",
118-
"email": "john@example.com"
119-
}
120-
}
121-
122-
// Test with custom headers
123-
{
124-
"method": "GET",
125-
"endpoint": "/products",
126-
"headers": {
127-
"Accept-Language": "en-US",
128-
"X-Custom-Header": "custom-value"
129-
}
130-
}
131-
```
132-
133-
## Development
134-
135-
1. Clone the repository:
136-
```bash
137-
git clone https://github.com/zenturacp/mcp-rest-api.git
138-
cd mcp-rest-api
139-
```
140-
141-
2. Install dependencies:
142-
```bash
143-
npm install
144-
```
145-
146-
3. Build the project:
147-
```bash
148-
npm run build
149-
```
150-
151-
For development with auto-rebuild:
152-
```bash
153-
npm run watch
154-
```
155-
156-
## License
157-
158-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
1+
# MCP REST API Tester
2+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
3+
[![NPM Package](https://img.shields.io/npm/v/dkmaker-mcp-rest-api.svg)](https://www.npmjs.com/package/dkmaker-mcp-rest-api)
4+
5+
A TypeScript-based MCP server that enables testing of REST APIs through Cline. This tool allows you to test and interact with any REST API endpoints directly from your development environment.
6+
7+
<a href="https://glama.ai/mcp/servers/izr2sp4rqo">
8+
<img width="380" height="200" src="https://glama.ai/mcp/servers/izr2sp4rqo/badge" />
9+
</a>
10+
11+
## Installation
12+
13+
1. Install the package globally:
14+
```bash
15+
npm install -g dkmaker-mcp-rest-api
16+
```
17+
18+
2. Add the server to your MCP configuration:
19+
20+
While these instructions are for Cline, the server should work with any MCP implementation. Configure based on your operating system:
21+
22+
### Windows
23+
⚠️ **IMPORTANT**: Due to a known issue with Windows path resolution ([issue #40](https://github.com/modelcontextprotocol/servers/issues/40)), you must use the full path instead of %APPDATA%.
24+
25+
Add to `C:\Users\<YourUsername>\AppData\Roaming\Code\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json`:
26+
```json
27+
{
28+
"mcpServers": {
29+
"rest": {
30+
"command": "node",
31+
"args": [
32+
"C:/Users/<YourUsername>/AppData/Roaming/npm/node_modules/dkmaker-mcp-rest-api/build/index.js"
33+
],
34+
"env": {
35+
"REST_BASE_URL": "https://api.example.com",
36+
// Basic Auth
37+
"AUTH_BASIC_USERNAME": "your-username",
38+
"AUTH_BASIC_PASSWORD": "your-password",
39+
// OR Bearer Token
40+
"AUTH_BEARER": "your-token",
41+
// OR API Key
42+
"AUTH_APIKEY_HEADER_NAME": "X-API-Key",
43+
"AUTH_APIKEY_VALUE": "your-api-key",
44+
// SSL Verification (enabled by default)
45+
"REST_ENABLE_SSL_VERIFY": "false" // Set to false to disable SSL verification for self-signed certificates
46+
}
47+
}
48+
}
49+
}
50+
```
51+
52+
### macOS
53+
Add to `~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json`:
54+
```json
55+
{
56+
"mcpServers": {
57+
"rest": {
58+
"command": "npx",
59+
"args": [
60+
"-y",
61+
"dkmaker-mcp-rest-api"
62+
],
63+
"env": {
64+
"REST_BASE_URL": "https://api.example.com",
65+
// Basic Auth
66+
"AUTH_BASIC_USERNAME": "your-username",
67+
"AUTH_BASIC_PASSWORD": "your-password",
68+
// OR Bearer Token
69+
"AUTH_BEARER": "your-token",
70+
// OR API Key
71+
"AUTH_APIKEY_HEADER_NAME": "X-API-Key",
72+
"AUTH_APIKEY_VALUE": "your-api-key",
73+
// SSL Verification (enabled by default)
74+
"REST_ENABLE_SSL_VERIFY": "false" // Set to false to disable SSL verification for self-signed certificates
75+
}
76+
}
77+
}
78+
}
79+
```
80+
81+
Note: Replace the environment variables with your actual values. Only configure one authentication method at a time:
82+
1. Basic Authentication (username/password)
83+
2. Bearer Token (if Basic Auth is not configured)
84+
3. API Key (if neither Basic Auth nor Bearer Token is configured)
85+
86+
## Features
87+
88+
- Test REST API endpoints with different HTTP methods
89+
- Support for GET, POST, PUT, and DELETE requests
90+
- Detailed response information including status, headers, and body
91+
- Custom header support
92+
- Request body handling for POST/PUT methods
93+
- SSL Certificate Verification:
94+
- Enabled by default for secure operation
95+
- Can be disabled for self-signed certificates or development environments
96+
- Control via REST_ENABLE_SSL_VERIFY environment variable
97+
- Multiple authentication methods:
98+
- Basic Authentication (username/password)
99+
- Bearer Token Authentication
100+
- API Key Authentication (custom header)
101+
102+
## Usage
103+
104+
Once installed and configured, you can use the REST API Tester through Cline to test your API endpoints:
105+
106+
```typescript
107+
// Test a GET endpoint
108+
{
109+
"method": "GET",
110+
"endpoint": "/users"
111+
}
112+
113+
// Test a POST endpoint with body
114+
{
115+
"method": "POST",
116+
"endpoint": "/users",
117+
"body": {
118+
"name": "John Doe",
119+
"email": "john@example.com"
120+
}
121+
}
122+
123+
// Test with custom headers
124+
{
125+
"method": "GET",
126+
"endpoint": "/products",
127+
"headers": {
128+
"Accept-Language": "en-US",
129+
"X-Custom-Header": "custom-value"
130+
}
131+
}
132+
```
133+
134+
## Development
135+
136+
1. Clone the repository:
137+
```bash
138+
git clone https://github.com/zenturacp/mcp-rest-api.git
139+
cd mcp-rest-api
140+
```
141+
142+
2. Install dependencies:
143+
```bash
144+
npm install
145+
```
146+
147+
3. Build the project:
148+
```bash
149+
npm run build
150+
```
151+
152+
For development with auto-rebuild:
153+
```bash
154+
npm run watch
155+
```
156+
157+
## License
158+
159+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)