refactor to run with --mcp and add metrics

Author: NicolasIRAGNE

CHANGELOG.md

@@ -5,7 +5,7 @@
 ### Features
 
 * **mcp:** Add Model Context Protocol (MCP) server support
-  - New `--mcp-server` CLI option to start MCP server
+  - New `--mcp` CLI option to start MCP server
   - `ingest_repository` tool for LLM integration
   - Full MCP protocol compliance with stdio transport
   - Enhanced MCP client examples for stdio transport

examples/mcp-config.json

@@ -2,7 +2,7 @@
   "mcpServers": {
     "gitingest": {
       "command": "gitingest",
-      "args": ["--mcp-server"],
+      "args": ["--mcp"],
       "env": {
         "GITHUB_TOKEN": "${GITHUB_TOKEN}"
       }

src/gitingest/__main__.py

@@ -4,6 +4,7 @@
 from __future__ import annotations
 
 import asyncio
+import os
 from typing import TypedDict
 
 import click
@@ -29,7 +30,10 @@ class _CLIArgs(TypedDict):
     include_submodules: bool
     token: str | None
     output: str | None
-    mcp_server: bool
+    mcp: bool
+    transport: str
+    host: str
+    port: int
 
 
 @click.command()
@@ -78,11 +82,31 @@ class _CLIArgs(TypedDict):
     help="Output file path (default: digest.txt in current directory). Use '-' for stdout.",
 )
 @click.option(
-    "--mcp-server",
+    "--mcp",
     is_flag=True,
     default=False,
     help="Start the MCP (Model Context Protocol) server for LLM integration",
 )
+@click.option(
+    "--transport",
+    type=click.Choice(["stdio", "tcp"]),
+    default="stdio",
+    show_default=True,
+    help="Transport protocol for MCP communication (only used with --mcp)",
+)
+@click.option(
+    "--host",
+    default="127.0.0.1",
+    show_default=True,
+    help="Host to bind TCP server (only used with --mcp --transport tcp)",
+)
+@click.option(
+    "--port",
+    type=int,
+    default=8001,
+    show_default=True,
+    help="Port for TCP server (only used with --mcp --transport tcp)",
+)
 def main(**cli_kwargs: Unpack[_CLIArgs]) -> None:
     """Run the CLI entry point to analyze a repo / directory and dump its contents.
 
@@ -107,7 +131,8 @@ def main(**cli_kwargs: Unpack[_CLIArgs]) -> None:
         $ gitingest https://github.com/user/repo --output -
 
     MCP server mode:
-        $ gitingest --mcp-server
+        $ gitingest --mcp
+        $ gitingest --mcp --transport tcp --host 0.0.0.0 --port 8001
 
     With filtering:
         $ gitingest -i "*.py" -e "*.log"
@@ -135,7 +160,10 @@ async def _async_main(
     include_submodules: bool = False,
     token: str | None = None,
     output: str | None = None,
-    mcp_server: bool = False,
+    mcp: bool = False,
+    transport: str = "stdio",
+    host: str = "127.0.0.1",
+    port: int = 8001,
 ) -> None:
     """Analyze a directory or repository and create a text dump of its contents.
 
@@ -165,8 +193,14 @@ async def _async_main(
     output : str | None
         The path where the output file will be written (default: ``digest.txt`` in current directory).
         Use ``"-"`` to write to ``stdout``.
-    mcp_server : bool
+    mcp : bool
         If ``True``, starts the MCP (Model Context Protocol) server instead of normal operation (default: ``False``).
+    transport : str
+        Transport protocol for MCP communication: "stdio" or "tcp" (default: "stdio").
+    host : str
+        Host to bind TCP server (only used with transport="tcp", default: "127.0.0.1").
+    port : int
+        Port for TCP server (only used with transport="tcp", default: 8001).
 
     Raises
     ------
@@ -177,14 +211,27 @@ async def _async_main(
 
     """
     # Check if MCP server mode is requested
-    if mcp_server:
+    if mcp:
         # Dynamic import to avoid circular imports and optional dependency
         try:
-            from gitingest.mcp_server import (  # noqa: PLC0415  # pylint: disable=import-outside-toplevel
-                start_mcp_server,
-            )
-
-            await start_mcp_server()
+            if transport == "tcp":
+                # Use TCP transport with FastMCP and metrics support
+                # Enable metrics for TCP mode if not already set
+                if os.getenv("GITINGEST_METRICS_ENABLED") is None:
+                    os.environ["GITINGEST_METRICS_ENABLED"] = "true"
+
+                from mcp_server.main import (  # pylint: disable=import-outside-toplevel  # noqa: PLC0415
+                    start_mcp_server_tcp,
+                )
+
+                await start_mcp_server_tcp(host, port)
+            else:
+                # Use stdio transport (default) - metrics not available in stdio mode
+                from gitingest.mcp_server import (  # pylint: disable=import-outside-toplevel  # noqa: PLC0415
+                    start_mcp_server,
+                )
+
+                await start_mcp_server()
         except ImportError as e:
             msg = f"MCP server dependencies not installed: {e}"
             raise click.ClickException(msg) from e

src/gitingest/mcp_server.py

@@ -7,6 +7,7 @@
 from mcp.server import Server  # pylint: disable=import-error
 from mcp.server.stdio import stdio_server  # pylint: disable=import-error
 from mcp.types import TextContent, Tool  # pylint: disable=import-error
+from prometheus_client import Counter
 
 from gitingest.entrypoint import ingest_async
 from gitingest.utils.logging_config import get_logger
@@ -17,6 +18,10 @@
 # Initialize logger for this module
 logger = get_logger(__name__)
 
+# Create Prometheus metrics
+mcp_ingest_counter = Counter("gitingest_mcp_ingest_total", "Number of MCP ingests", ["status"])
+mcp_tool_calls_counter = Counter("gitingest_mcp_tool_calls_total", "Number of MCP tool calls", ["tool_name", "status"])
+
 # Create the MCP server instance
 app = Server("gitingest")
 
@@ -84,11 +89,18 @@ async def list_tools() -> list[Tool]:
 async def call_tool(name: str, arguments: dict[str, Any]) -> Sequence[TextContent]:
     """Execute a tool."""
     try:
+        mcp_tool_calls_counter.labels(tool_name=name, status="started").inc()
+
         if name == "ingest_repository":
-            return await _handle_ingest_repository(arguments)
+            result = await _handle_ingest_repository(arguments)
+            mcp_tool_calls_counter.labels(tool_name=name, status="success").inc()
+            return result
+
+        mcp_tool_calls_counter.labels(tool_name=name, status="unknown_tool").inc()
         return [TextContent(type="text", text=f"Unknown tool: {name}")]
     except Exception as e:
         logger.exception("Error in tool call %s", name)
+        mcp_tool_calls_counter.labels(tool_name=name, status="error").inc()
         return [TextContent(type="text", text=f"Error executing {name}: {e!s}")]
 
 
@@ -143,10 +155,12 @@ async def _handle_ingest_repository(arguments: dict[str, Any]) -> Sequence[TextC
 *Generated by Gitingest MCP Server*
 """
 
+        mcp_ingest_counter.labels(status="success").inc()
         return [TextContent(type="text", text=response_content)]
 
     except Exception as e:
         logger.exception("Error during ingestion")
+        mcp_ingest_counter.labels(status="error").inc()
         return [TextContent(type="text", text=f"Error ingesting repository: {e!s}")]
 
 

src/mcp_server/__main__.py

@@ -28,7 +28,7 @@
 @click.option(
     "--port",
     type=int,
-    default=8001,
+    default=8000,
     show_default=True,
     help="Port for TCP server (only used with --transport tcp)",
 )

src/mcp_server/main.py

@@ -2,14 +2,31 @@
 
 from __future__ import annotations
 
+import os
+import threading
+
+import uvicorn
+from fastapi import FastAPI
+from fastapi.middleware.cors import CORSMiddleware
+from fastapi.responses import JSONResponse
 from mcp.server.fastmcp import FastMCP  # pylint: disable=import-error
+from prometheus_client import Counter
 
 from gitingest.entrypoint import ingest_async
 from gitingest.utils.logging_config import get_logger
+from server.metrics_server import start_metrics_server
 
 # Initialize logger for this module
 logger = get_logger(__name__)
 
+# Create Prometheus metrics
+fastmcp_ingest_counter = Counter("gitingest_fastmcp_ingest_total", "Number of FastMCP ingests", ["status"])
+fastmcp_tool_calls_counter = Counter(
+    "gitingest_fastmcp_tool_calls_total",
+    "Number of FastMCP tool calls",
+    ["tool_name", "status"],
+)
+
 # Create the FastMCP server instance
 mcp = FastMCP("gitingest")
 
@@ -40,6 +57,7 @@ async def ingest_repository(
 
     """
     try:
+        fastmcp_tool_calls_counter.labels(tool_name="ingest_repository", status="started").inc()
         logger.info("Starting MCP ingestion", extra={"source": source})
 
         # Convert patterns to sets if provided
@@ -58,8 +76,14 @@ async def ingest_repository(
             token=token,
             output=None,  # Don't write to file, return content instead
         )
+
+        fastmcp_ingest_counter.labels(status="success").inc()
+        fastmcp_tool_calls_counter.labels(tool_name="ingest_repository", status="success").inc()
+
     except Exception:
         logger.exception("Error during ingestion")
+        fastmcp_ingest_counter.labels(status="error").inc()
+        fastmcp_tool_calls_counter.labels(tool_name="ingest_repository", status="error").inc()
         return "Error ingesting repository: An internal error occurred"
 
     # Create a structured response and return directly
@@ -85,10 +109,17 @@ async def start_mcp_server_tcp(host: str = "127.0.0.1", port: int = 8001) -> Non
     """Start the MCP server with HTTP transport using SSE."""
     logger.info("Starting Gitingest MCP server with HTTP/SSE transport on %s:%s", host, port)
 
-    import uvicorn  # noqa: PLC0415  # pylint: disable=import-outside-toplevel
-    from fastapi import FastAPI  # noqa: PLC0415  # pylint: disable=import-outside-toplevel
-    from fastapi.middleware.cors import CORSMiddleware  # noqa: PLC0415  # pylint: disable=import-outside-toplevel
-    from fastapi.responses import JSONResponse  # noqa: PLC0415  # pylint: disable=import-outside-toplevel
+    # Start metrics server in a separate thread if enabled
+    if os.getenv("GITINGEST_METRICS_ENABLED") is not None:
+        metrics_host = os.getenv("GITINGEST_METRICS_HOST", "127.0.0.1")
+        metrics_port = int(os.getenv("GITINGEST_METRICS_PORT", "9090"))
+        metrics_thread = threading.Thread(
+            target=start_metrics_server,
+            args=(metrics_host, metrics_port),
+            daemon=True,
+        )
+        metrics_thread.start()
+        logger.info("Started metrics server on %s:%s", metrics_host, metrics_port)
 
     tcp_app = FastAPI(title="Gitingest MCP Server", description="MCP server over HTTP/SSE")