Skip to content

Commit 0883419

Browse files
committed
docs: add Cline custom instructions to installation steps
1 parent 8c6100f commit 0883419

File tree

2 files changed

+48
-41
lines changed

2 files changed

+48
-41
lines changed

CLINE-CUSTOM-INSTRUCTIONS.md

Lines changed: 0 additions & 39 deletions
This file was deleted.

README.md

Lines changed: 48 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,53 @@ npx -y @smithery/cli install dkmaker-mcp-rest-api --client claude
2525
npm install -g dkmaker-mcp-rest-api
2626
```
2727

28-
2. Add the server to your MCP configuration:
28+
2. Configure Cline Custom Instructions:
29+
30+
To ensure Cline understands how to effectively use this tool, add the following to your Cline custom instructions (Settings > Custom Instructions):
31+
32+
```markdown
33+
# REST API Testing Instructions
34+
35+
The `test_request` tool enables testing, debugging, and interacting with REST API endpoints. The tool provides comprehensive request/response information and handles authentication automatically.
36+
37+
## When to Use
38+
39+
- Testing specific API endpoints
40+
- Debugging API responses
41+
- Verifying API functionality
42+
- Checking response times
43+
- Validating request/response formats
44+
- Testing local development servers
45+
- Testing API sequences
46+
- Verifying error handling
47+
48+
## Key Features
49+
50+
- Supports GET, POST, PUT, DELETE methods
51+
- Handles authentication (Basic, Bearer, API Key)
52+
- Normalizes endpoints automatically
53+
- Provides detailed response information
54+
- Configurable SSL verification and response limits
55+
56+
## Resources
57+
58+
The following resources provide detailed documentation:
59+
60+
- examples: Usage examples and common patterns
61+
- response-format: Response structure and fields
62+
- config: Configuration options and setup guide
63+
64+
Access these resources to understand usage, response formats, and configuration options.
65+
66+
## Important Notes
67+
68+
- Review API implementation for expected behavior
69+
- Handle sensitive data appropriately
70+
- Consider rate limits and API constraints
71+
- Restart server after configuration changes
72+
```
73+
74+
3. Add the server to your MCP configuration:
2975

3076
While these instructions are for Cline, the server should work with any MCP implementation. Configure based on your operating system:
3177

@@ -117,7 +163,7 @@ Note: Replace the environment variables with your actual values. Only configure
117163
- Bearer Token Authentication
118164
- API Key Authentication (custom header)
119165

120-
## Usage
166+
## Usage Examples
121167

122168
Once installed and configured, you can use the REST API Tester through Cline to test your API endpoints:
123169

0 commit comments

Comments
 (0)