diff --git a/README.md b/README.md index ff4c8f39..55ee937a 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,44 @@ AI agents act as the "Maître D'" — presenting the menu to users as honoured g See: `.machine_readable/servers/menu.a2ml` +## MCP Installation + +The BoJ server exposes its cartridges via MCP (Model Context Protocol) over stdio. + +**Prerequisites:** The BoJ REST server must be running on port 7700 (see Quick Start below). + +### Claude Code + +Add to `~/.config/claude/mcp_servers.json`: + +```json +{ + "boj-server": { + "command": "node", + "args": ["/path/to/boj-server/mcp-bridge/main.js"], + "env": { "BOJ_URL": "http://localhost:7700" } + } +} +``` + +### Other MCP Clients + +```bash +node mcp-bridge/main.js +# or +deno run --allow-net --allow-env mcp-bridge/main.js +``` + +### MCP Tools + +| Tool | Description | +|------|-------------| +| `boj_health` | Server health check | +| `boj_menu` | List all cartridges (tiers, domains, protocols) | +| `boj_cartridges` | Protocol x domain capability matrix | +| `boj_cartridge_info` | Detailed info for a specific cartridge | +| `boj_cartridge_invoke` | Execute a cartridge operation | + ## Quick Start ```bash diff --git a/mcp-bridge/main.js b/mcp-bridge/main.js old mode 100644 new mode 100755 index 3148d9b6..290962ce --- a/mcp-bridge/main.js +++ b/mcp-bridge/main.js @@ -1,3 +1,4 @@ +#!/usr/bin/env node // SPDX-License-Identifier: PMPL-1.0-or-later // Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) // diff --git a/mcp-bridge/package.json b/mcp-bridge/package.json new file mode 100644 index 00000000..44b68cd4 --- /dev/null +++ b/mcp-bridge/package.json @@ -0,0 +1,33 @@ +{ + "name": "@hyperpolymath/boj-server", + "version": "0.2.0", + "description": "Bundle of Joy (BoJ) MCP Server — cartridge-based DevOps toolkit with 18 domain cartridges (database, container, git, k8s, observability, secrets, IaC, and more)", + "license": "MPL-2.0", + "author": "Jonathan D.A. Jewell ", + "repository": { + "type": "git", + "url": "https://github.com/hyperpolymath/boj-server.git" + }, + "keywords": [ + "mcp", + "mcp-server", + "devops", + "containers", + "kubernetes", + "database", + "git", + "observability", + "iac", + "secrets" + ], + "type": "module", + "bin": { + "boj-server": "./main.js" + }, + "files": [ + "main.js" + ], + "engines": { + "node": ">=18.0.0" + } +}