Thank you for your interest in contributing to LMStudio-MCP! This document provides guidelines and instructions for contributing.
- Bug reports: Help identify issues with the bridge
- Feature suggestions: Propose new features or improvements
- Model compatibility notes: Share your experiences with different models
- Documentation improvements: Help improve or clarify the documentation
- Code contributions: Fix bugs or implement new features
When reporting issues, please include:
- A clear description of the problem
- Steps to reproduce the issue
- The model(s) you were using when the issue occurred
- Any error messages or logs
- Your environment (OS, Python version, LM Studio version)
We're building a database of model compatibility information. If you've tested LMStudio-MCP with specific models, please share your findings:
- Model name and version
- Whether it worked correctly
- Any specific parameters that improved performance
- Any limitations or issues encountered
- Fork the repository
- Create a new branch for your changes
- Make your changes
- Test your changes thoroughly
- Submit a pull request with a clear description of the changes
For significant changes, please open an issue first to discuss the proposed changes.
- Clone the repository
- Install development dependencies:
pip install -e ".[dev]" - Make your changes
- Test your changes with a local LM Studio instance
- Follow PEP 8 guidelines
- Use clear, descriptive variable and function names
- Add docstrings for functions and classes
- Include type hints where applicable
By contributing to this project, you agree that your contributions will be licensed under the project's MIT License.