Skip to content

Commit d1cd23f

Browse files
yogesh-chauhanHarness
authored andcommitted
chore: add PR Guidelines for MCP tooling (#39)
* chore: add PR template for MCP tooling
1 parent be13534 commit d1cd23f

File tree

1 file changed

+85
-0
lines changed

1 file changed

+85
-0
lines changed

.harness/pull_request_template.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
2+
# MCP Tooling Pull Request
3+
4+
## Tool Information
5+
6+
- **Tool Name**: [Clear, descriptive name without ambiguity]
7+
- **Purpose**: [Briefly explain what this tool does and its use case]
8+
- **Target Users**: [Who will be using this tool?]
9+
10+
## Tool Description
11+
12+
[Provide a clear, detailed description of the tool's functionality. Make it understandable for both humans and LLMs.]
13+
14+
### Key Features
15+
- [ ] Feature 1
16+
- [ ] Feature 2
17+
- [ ] Feature 3
18+
19+
## Tool Naming and Clarity
20+
- [ ] Tool name is clear, descriptive, and follows naming conventions
21+
- [ ] No ambiguity or duplication with existing tool names
22+
- [ ] All parameters and return values have clear, descriptive names
23+
- [ ] Error messages are clear and actionable
24+
25+
## Example Responses
26+
27+
### Successful Response Example
28+
```json
29+
{
30+
"success": true,
31+
"data": {
32+
// Response data here
33+
},
34+
"metadata": {
35+
"request_id": "req_12345",
36+
"timestamp": "2025-07-11T09:03:33Z"
37+
}
38+
}
39+
```
40+
41+
### Error Response Example
42+
```json
43+
{
44+
"success": false,
45+
"error": {
46+
"code": "INVALID_INPUT",
47+
"message": "Detailed error message",
48+
"details": {
49+
"field": "field_name",
50+
"issue": "must be a valid value"
51+
}
52+
}
53+
}
54+
```
55+
56+
## Screenshots
57+
58+
### Windsurf Client Integration
59+
<!-- Add screenshot of the tool in action within Windsurf -->
60+
![Windsurf Tool Usage](path/to/windsurf-screenshot.png)
61+
*Figure 1: Tool usage in Windsurf client*
62+
63+
### GenAI Service Integration
64+
<!-- Add screenshot of the tool being called from GenAI service -->
65+
![GenAI Service Tool Call](path/to/genai-tool-call.png)
66+
*Figure 2: Tool call in GenAI service*
67+
68+
### Sample Responses
69+
<!-- Add screenshot of example responses -->
70+
![Example Response](path/to/example-response.png)
71+
*Figure 3: Example response visualization*
72+
73+
## Testing Requirements
74+
75+
### Client Verification
76+
- [ ] Verified with actual client requests from Windsurf
77+
- [ ] Verified with actual client requests from GenAI service
78+
- [ ] All sample requests/responses in this PR match actual client behavior
79+
- [ ] Error cases are properly handled and return appropriate error messages
80+
- [ ] Rate limiting and authentication work as expected
81+
82+
### Screenshot Verification
83+
- [ ] Screenshots are up-to-date with the current UI
84+
- [ ] Sensitive information is redacted from screenshots
85+
- [ ] Screenshots clearly demonstrate the tool's functionality

0 commit comments

Comments
 (0)