up dev`
4. Install `mcp-git-commit-generator` using the command: `uv pip install -e .`. | | Using `pip` | 1. Create virtual environment: `python -m venv .venv`
2. Run VSCode Command "***Python: Select Interpreter***" and select the python from created virtual environment
3. Install dependencies: `pip install -e .`.
4. Install pip dev dependencies: `pip install -r requirements-dev.txt`. | 3. **(Optional) Install Inspector dependencies:** ```sh cd inspector npm install ``` ### 📦 Publishing to PyPI The project includes an automated PyPI publishing workflow (`.github/workflows/pypi-publish.yml`) that: - **Triggers on**: Tag pushes matching `v*.*.*` pattern, manual workflow dispatch, or pull requests to main - **Builds**: Python package distributions using the `build` package - **Publishes**: Automatically publishes to PyPI using trusted publishing (OIDC) when tags are pushed To publish a new version: 1. Update the version in `pyproject.toml` 2. Create and push a git tag: `git tag vX.Y.Z && git push origin vX.Y.Z` 3. The workflow will automatically build and publish to PyPI ### 🐳 Building and Running with Docker You can build and run the MCP Git Commit Generator using Docker. The provided Dockerfile uses a multi-stage build with [`uv`](https://github.com/astral-sh/uv) for dependency management and runs the server as a non-root user for security. #### Build the Docker image ```sh docker build -t mcp-git-commit-generator . ``` #### Run the server in a container (default: stdio transport) You can run the published image directly from GitHub Container Registry. ```sh docker run -d \ --name mcp-git-commit-generator \ ghcr.io/theoklitosbam7/mcp-git-commit-generator:latest ``` By default, the container runs: ```sh mcp-git-commit-generator --transport stdio ``` If you want to use SSE transport (for Inspector UI or remote access), override the entrypoint or run manually: ```sh docker run -d \ --name mcp-git-commit-generator \ -p 3001:3001 \ --entrypoint mcp-git-commit-generator \ ghcr.io/theoklitosbam7/mcp-git-commit-generator:latest --transport sse --host 0.0.0.0 --port 3001 ``` The server will be available at `http://localhost:3001` when using SSE. ### 🖥️ Running the Server Locally **To run locally (without Docker):** 1. Set up your uv or Python environment as described in the Local Development Setup section. 2. From the project root, run:

mcp-git-commit-generator

```sh # If you have mcp-git-commit-generator installed in your environment (default: stdio) mcp-git-commit-generator ```

mcp-git-commit-generator with SSE transport

```sh mcp-git-commit-generator --transport sse ```

Using uv

```sh uv run -m mcp_git_commit_generator --transport sse ```

Using Python directly

```sh python -m mcp_git_commit_generator --transport sse ```

You can specify other options, for example: ```sh python -m mcp_git_commit_generator --transport sse --host 0.0.0.0 --port 3001 -v ``` > The server listens on `0.0.0.0:3001` by default when using SSE, or as specified by the options above. **Note:** - If you want to use the CLI entrypoint, ensure the package is installed and your environment is activated. - Do not use positional arguments (e.g., `python -m mcp_git_commit_generator sse`); always use options like `--transport sse`. - Available arguments with their values are: - `--transport`: Transport type (e.g., `stdio` (default), `sse`). - `--host`: Host to bind the server (default: `0.0.0.0`). - `--port`: Port to bind the server (default: `3001`). - `-v`, `--verbose`: Verbosity level (e.g., `-v`, `-vv`). ### 🔎 Start the Inspector UI From the `inspector` directory: ```sh npm run dev:inspector ``` > The Inspector UI will be available at `http://localhost:5173`. ### 🗂️ Project Structure ```sh . ├── .gi

#commit-generator

Mcp Git Commit Generator