Agents-MCP-Hackathon/documentation_mcp_tool

Pydocstyle Documentation Checker (via Modal MCP)

This Gradio application provides an interface to check Python code for documentation style issues using Pydocstyle. The analysis is performed by a Pydocstyle tool running on a Modal Labs Multi-Compute-Platform (MCP) server.

How to Use

1. 1.Input Parameters:
2. 2.The input field expects a JSON object.
3. 3.This JSON object must contain a key named "code" whose value is the Python code string you want to analyze.
4. 4.An example is pre-filled for convenience:

        {
          "code": "# No module docstring here\n\ndef example_function_missing_docstring():\n    pass\n\nclass ExampleClassMissingDocstring:\n    def method_missing_docstring(self):\n        pass\n\ndef well_documented_function():\n    \"\"\"This function is well documented.\"\"\"\n    return True\n"
        }

1. 1.Submit: Click the "Submit" button.

1. 1.Output:
2. 2.The application will send the code to the Pydocstyle tool on the Modal MCP server.
3. 3.The results of the Pydocstyle analysis will be displayed as a JSON object in the output field. This JSON will typically include:
4. 4.tool: "pydocstyle"
5. 5.errors: A list of documentation errors found, with details like error code, message, and line number.
6. 6.files_checked: Number of files checked (usually 1 for the provided code snippet).
7. 7.Any errors encountered during the process.

Configuration

For this application to function correctly, the MODAL_MCP_ENDPOINT environment variable must be set. This variable should point to your deployed Modal function that handles MCP tool execution (e.g., the /execute_tool endpoint).

• —Create a .env file in the mcp_deploy directory (or the root of your Space if deploying to Hugging Face Spaces and it's not automatically picked up from this directory).
• —Add the following line to the .env file, replacing the placeholder with your actual Modal endpoint URL:

    MODAL_MCP_ENDPOINT="https://your-username--mcp-server-app-execute-tool.modal.run"

If the MODAL_MCP_ENDPOINT is not set or is incorrect, the application will display an error message upon submission.

Next step

Add more tools to analyse different other aspects.