GenCodeDoc

GenCodeDoc MCP Server provides intelligent versioning and automated Markdown documentation generation with full MCP support, enabling seamless control of snapshots, documentation, and project automation through multiple IPC transports for AI assistants.

How to use

You can control GenCodeDoc using an MCP client via REST, standard IO, or SSE transports. Start by connecting through the HTTP API to manage snapshots and generate documentation, or use a local stdio server to interact directly from your MCP client. The system is designed to let your AI assistants orchestrate project documentation tasks, compare versions, and generate up-to-date project documentation with minimal manual steps.

How to install

Prerequisites you need before installing GenCodeDoc:

Step-by-step installation:

How to install

# Clone the project repository
git clone https://github.com/VOTRE_NOM/gencodedoc.git
cd gencodedoc

# Install dependencies with Poetry
poetry install

# Verify installation
poetry run gencodedoc --help

Additional sections

Configuration and MCP integration details are provided below. You can enable automated autosave, manage snapshots, and generate documentation through the available MCP tools. The server exposes both a local stdio interface for CLI-based clients and HTTP/SSE servers for web and GUI clients.

MCP server configuration

The MCP server can be accessed via a local HTTP endpoint as well as a local stdio interface. Use the following configuration to connect your MCP client.

MCP server configuration blocks

{
  "mcpServers": {
    "gencodedoc": {
      "type": "stdio",
      "command": "/path/to/your/poetry-venv/bin/python",
      "args": ["-m", "gencodedoc.mcp.server_stdio"],
      "env": {
        "PROJECT_PATH": "/path/to/your/target-project"
      }
    }
  }
}

MCP transport endpoints

In addition to the stdio interface, GenCodeDoc offers two HTTP-based transport endpoints for MCP clients and tools.

HTTP and SSE / REST endpoints

HTTP servers run locally at the standard development port, exposing the MCP API for RESTful interactions. SSE servers provide push-based communication for GUI clients. The two servers are reachable at the local address http://127.0.0.1:8000.

Available tools and endpoints

GenCodeDoc exposes a comprehensive set of MCP tools spanning snapshots, documentation, project management, configuration, and autosave controls.

Notes on usage

After configuring your MCP client, you can issue requests such as creating a snapshot with a specific tag and message, reviewing differences between versions, or generating a complete project documentation. Automation and AI-assisted workflows are supported through the MCP tools and transports described above.

Architecture and operation

GenCodeDoc uses a SQLite database to store metadata and de-duplicates file contents by SHA256 hash, followed by compression with zstandard to minimize disk usage while preserving exact file contents.

Troubleshooting

If you encounter issues starting the MCP servers, ensure Python 3.10+ is active in your environment, Poetry dependencies are installed, and the Python executable path in the stdio configuration is correct. Verify that the local HTTP server is reachable at http://127.0.0.1:8000 and that the PROJECT_PATH environment variable points to your target project.

Tools and endpoints reference

A complete list of available MCP tools and their endpoints is provided in the tool catalog within the MPC interface. Use the tools to perform snapshot operations, documentation generation, and configuration management.

Security considerations

Keep MCP API access restricted to trusted clients. Use authentication best practices for HTTP transport and ensure local stdio access remains within secure environments.

Available tools

create_snapshot

Create a new snapshot of the current project state with a message and optional tag.

list_snapshots

List all stored snapshots with their metadata.

get_snapshot_details

Retrieve detailed information about a specific snapshot.

restore_snapshot

Restore the project state from a chosen snapshot.

delete_snapshot

Remove a snapshot from storage.

diff_versions

Show differences between two project versions in unified, JSON, or semantic form.

generate_documentation

Generate a complete Markdown documentation for the project.

preview_structure

Preview the documentation structure before generation.

get_project_stats

Fetch statistical information about the project and its snapshots.

init_project

Initialize a new GenCodeDoc project with presets.

get_project_status

Check the current status of the GenCodeDoc project.

get_config

Retrieve current GenCodeDoc configuration.

set_config_value

Set a configuration value for GenCodeDoc.

apply_preset

Apply a predefined configuration preset to the project.

manage_ignore_rules

Manage ignore rules for files within the project.

start_autosave

Enable or start the autosave feature.

stop_autosave

Disable or stop the autosave feature.

get_autosave_status

Check the status of the autosave feature.