Skip to main content
This guide will help you set up your development environment and contribute to mcp-use.

Prerequisites

  • Python 3.11 or higher
  • Git
  • Node.js and npm (for MCP server dependencies)

Setting Up Development Environment

  1. Clone the repository:
  1. Install development dependencies:
  1. Install pre-commit hooks:

Code Style

mcp_use uses Ruff for code formatting and linting. The project follows these style guidelines:
  • Use type hints for all function parameters and return values
  • Follow PEP 8 style guide
  • Use docstrings for all public functions and classes
  • Keep functions focused and single-purpose

Running Tests

The project uses pytest for testing. To run the test suite:
For more specific test runs:

Documentation

Documentation is written in MDX format and uses Mintlify for rendering. To preview documentation changes:
  1. Install Mintlify CLI:
  1. Navigate to the docs directory and run the development server:

Contributing

  1. Create a new branch for your feature:
  1. Make your changes and commit them:
  1. Push your changes and create a pull request:

Project Structure