erm-github

Ein schlichter Model Context Protocol (MCP)-Server, geschrieben in TypeScript. Er ist dafür gedacht, aus dem Quellcode gebaut, mit Docker containerisiert und auf IBM Code Engine bereitgestellt zu werden.

Inhaltsverzeichnis

• Übersicht

• Projektstruktur

• Tools

• Lokale Entwicklung

• Mit Docker ausführen

• GitHub Actions CI/CD

• Bereitstellung auf IBM Code Engine

• Verbinden mit Bob (IBM Bob Desktop)

• Erweitern des Servers

Related MCP server: My Awesome MCP

Übersicht

Dieser Server unterstützt zwei Transporte:

Der HTTP-Transport stellt einen /health-Endpunkt unter GET /health für Liveness-Proben bereit.

Projektstruktur

.
├── src/
│   └── index.ts          # Server entry point — add tools here
├── build/                # Compiled output (git-ignored)
├── .github/
│   └── workflows/
│       └── build-push.yml  # CI: typecheck → build → push to GHCR
├── Dockerfile            # Multi-stage build (builder + runtime)
├── docker-compose.yml    # Local container testing
├── tsconfig.json
└── package.json

Tools

Lokale Entwicklung

Voraussetzungen

• Node.js 20+

• npm 10+

Installieren und bauen

npm install
npm run build

Im stdio-Modus ausführen (für die Verwendung mit Bob Desktop)

node build/index.js

Lokal im HTTP-Modus ausführen

MCP_TRANSPORT=http PORT=3000 node build/index.js

Testen Sie den Health-Endpunkt:

curl http://localhost:3000/health

Mit Docker ausführen

Docker-Image erstellen

docker build -t erm-github-mcp .

Container ausführen

docker run -p 3000:3000 erm-github-mcp

Docker Compose verwenden

docker compose up --build

GitHub Actions CI/CD

Der Workflow in .github/workflows/build-push.yml wird bei jedem Push auf main und bei Versions-Tags (v*) ausgeführt:

1. TypeScript-Build – npm ci + tsc (bricht bei Typfehlern sofort ab)

2. Docker-Build & -Push – Multi-Plattform-Image (linux/amd64, linux/arm64), gepusht an die GitHub Container Registry (GHCR)

Das Image wird wie folgt veröffentlicht:

ghcr.io/<your-github-username>/erm-github-mcp:<tag>

Es müssen keine Secrets konfiguriert werden – der Workflow verwendet den integrierten GITHUB_TOKEN.

Paket öffentlich machen

Nach dem ersten Push: Navigieren Sie zu GitHub → Pakete → erm-github-mcp → Paketeinstellungen und setzen Sie die Sichtbarkeit auf Public, damit Code Engine das Image ohne Anmeldedaten abrufen kann.

Bereitstellung auf IBM Code Engine

Voraussetzungen

• IBM Cloud CLI mit dem Code Engine-Plugin:

  ibmcloud plugin install code-engine

• Ein IBM-Cloud-Konto und ein Code Engine-Projekt

Schritte

1. Wählen Sie Ihr Projekt aus

ibmcloud ce project select --name <your-project-name>

2. Anwendung bereitstellen

Ersetzen Sie <tag> durch das Image-Tag, das Sie bereitstellen möchten (z. B. main oder v0.1.0):

ibmcloud ce application create \
  --name erm-github-mcp \
  --image ghcr.io/<your-github-username>/erm-github-mcp:<tag> \
  --port 3000 \
  --min-scale 0 \
  --max-scale 5 \
  --env MCP_TRANSPORT=http \
  --env PORT=3000

3. Öffentliche URL abrufen

ibmcloud ce application get --name erm-github-mcp --output url

4. Nach einem neuen Image-Pushaktualisieren

ibmcloud ce application update \
  --name erm-github-mcp \
  --image ghcr.io/<your-github-username>/erm-github-mcp:<new-tag>

Umgebungsvariablen

Verbindung zu Bob herstellen (IBM Bob Desktop)

HTTP (remote – nach der Bereitstellung auf Code Engine)

Fügen Sie Ihrer Bob-mcp.json Folgendes hinzu:

{
  "mcpServers": {
    "erm-github-mcp": {
      "url": "https://<your-code-engine-url>"
    }
  }
}

stdio (lokal – für die Entwicklung)

{
  "mcpServers": {
    "erm-github-mcp": {
      "command": "node",
      "args": ["/absolute/path/to/erm-github-mcp/build/index.js"]
    }
  }
}

Erweitern des Servers

Fügen Sie mit server.tool() neue Tools in src/index.ts hinzu:

server.tool(
  "my_tool",
  "Description shown to the AI",
  {
    input_field: z.string().describe("What this field does"),
  },
  async ({ input_field }) => ({
    content: [{ type: "text", text: `Result: ${input_field}` }],
  })
);

Danach neu bauen:

npm run build

Lizenz

Apache 2.0