Sushi MCP Server

# Contributing to Sushi MCP Server Thank you for your interest in contributing to Sushi MCP Server! This document provides guidelines for contributing to the project. ## Getting Started 1. Fork the repository on GitHub 2. Clone your fork locally 3. Create a new branch for your feature or fix 4. Make your changes 5. Test your changes thoroughly 6. Commit your changes with clear, descriptive messages 7. Push to your fork and submit a pull request ## Development Setup 1. Follow the installation instructions in README.md 2. Install development dependencies: ```bash pip install pytest black flake8 ``` ## Code Style - Follow PEP 8 Python style guide - Use meaningful variable and function names - Add docstrings to all functions and classes - Keep lines under 100 characters when possible - Run `black .` to format code automatically ## Adding New Features When adding new MCP tools: 1. Add the tool function with the `@mcp.tool()` decorator 2. Include comprehensive docstrings with parameter descriptions 3. Implement proper error handling 4. Add logging for debugging 5. Update the README.md with the new functionality 6. Consider adding an example to example_usage.py ## Testing - Test your changes with a real Sushi instance if possible - Verify all existing functionality still works - Test edge cases and error conditions - Add unit tests for new functionality (when test framework is added) ## Pull Request Process 1. Update the README.md with details of changes if needed 2. Ensure your code follows the project's style guidelines 3. Include a clear description of the changes in your PR 4. Link any related issues 5. Be responsive to code review feedback ## Reporting Issues - Use the GitHub issue tracker - Include as much detail as possible: - Sushi version - Python version - Complete error messages - Steps to reproduce - Label issues appropriately ## Code of Conduct - Be respectful and inclusive - Welcome newcomers and help them get started - Focus on constructive criticism - Respect differing viewpoints and experiences ## Questions? Feel free to open an issue for any questions about contributing!