Skip to content

Commit 8d6febb

Browse files
calclaviacalclavia
committed
Update README.md
1 parent 56898c5 commit 8d6febb

File tree

1 file changed

+169
-170
lines changed

1 file changed

+169
-170
lines changed

‎README.md‎

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

0 commit comments

Comments
 (0)