Best Practices

Provides up-to-date Python best practices and code guidelines for FastAPI projects via MCP.

python

0

GitHub Stars

python

Language

4 months ago

First Indexed

3 weeks ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "n-ochs-best-practice-mcp": {
      "command": "python",
      "args": [
        "/path/to/bestpractices_mcp_server.py"
      ],
      "env": {
        "LOG_LEVEL": "INFO",
        "BEST_PRACTICES_FILE": "data/python_best_practices.json"
      }
    }
  }
}

You run a dedicated MCP server that provides Python coding best practices and guidelines for general coding and API development with FastAPI. It offers quick access to searched practices, category browsing, practical code examples, and actionable improvements to keep your projects clean, efficient, and maintainable.

How to use

To use this MCP server, install and run the server locally, then connect with an MCP client in your IDE or tooling. You can search for best practices by keyword, browse by category, view code examples for topics like type hints or Pydantic models, have code reviewed against best practices, and obtain prioritized improvement suggestions. Access to practices is also available via URIs for direct reference.

How to install

Prerequisites: Python 3.8+ and a working command line.

Install dependencies required by the MCP server.

pip install -r requirements.txt

Additional sections

Configuration details are exposed through environment variables and runtime parameters. The server reads a best practices data source at startup and serves it to MCP clients.

Security considerations include running with restricted permissions and validating inputs from MCP clients. Avoid exposing sensitive files through the server data source.

Examples demonstrate how to perform common tasks like searching for a practice, retrieving topic-specific guidance, and requesting code reviews. See the Examples section for runnable scripts and how they exercise the server features.

Troubleshooting tips cover startup errors, invalid data sources, and empty search results. Ensure the data file exists, the JSON is valid, and your MCP client configuration points to the correct server entry point.

Development notes include how to run tests and how to extend the data source by editing the best practices JSON file.

Available tools

search_practices

Search best practices by keyword across all categories.

get_practice_by_category

Retrieve practices for a specific category and topic.

list_categories

List all available practice categories.

get_examples_tool

Fetch code examples for a given topic.

review_code

Review provided code against best practices and receive recommendations.

suggest_improvements

Provide prioritized improvement suggestions with before/after examples.