Files
cyanheads b1feec0205 docs: add comprehensive tool examples and documentation
- Create examples directory with detailed tool usage documentation
- Add example request/response for each tool
- Update main README with links to examples
- Update .gitignore to include examples directory
2025-01-25 20:17:19 -08:00
..

Mentor MCP Server Tool Examples

This directory contains example requests and responses for each tool provided by the mentor-mcp-server. These examples demonstrate the capabilities and expected output format of each tool.

Tools

1. Second Opinion

Provides a second opinion on a user's request by analyzing it with an LLM and listing critical considerations. The example shows analysis of building a secure authentication system.

2. Code Review

Provides a code review for a given file or code snippet, focusing on potential bugs, style issues, performance bottlenecks, and security vulnerabilities. The example shows a review of the code review tool's own implementation.

3. Design Critique

Offers a critique of a design document, UI/UX mockup, or architectural diagram, focusing on usability, aesthetics, consistency, accessibility, and potential design flaws. The example shows analysis of a cloud monitoring dashboard design.

4. Writing Feedback

Provides feedback on a piece of writing, such as an essay, article, or technical documentation, focusing on clarity, grammar, style, structure, and overall effectiveness. The example shows feedback on a rate limiting implementation guide.

5. Brainstorm Enhancements

Generates creative ideas for improving a given concept, product, or feature, focusing on innovation, feasibility, and user value. The example shows enhancement ideas for an AI-powered code review tool.

Production Readiness

All tools have been tested and demonstrate:

  • Proper input validation and error handling
  • Comprehensive and well-structured responses
  • Consistent output formatting
  • Practical applicability to real-world scenarios
  • Deep domain expertise in their respective areas

The examples serve as both documentation and test cases, showing the expected behavior and quality of responses for each tool.