@galaxy-stack/orbit-mcp 0.1.0 → 0.1.2

package/README.md

@@ -1,9 +1,78 @@
+<div align="center">
+
 # @galaxy-stack/orbit-mcp
 
-Orbit framework package. See the [framework documentation](https://galaxy-orbit-framework.vercel.app).
+**Model Context Protocol server for the Orbit framework**
+
+Give AI coding agents first-class knowledge of Orbit: framework patterns, code scaffolding, and security review — through the [Model Context Protocol](https://modelcontextprotocol.io).
+
+[![npm version](https://img.shields.io/npm/v/@galaxy-stack/orbit-mcp.svg)](https://www.npmjs.com/package/@galaxy-stack/orbit-mcp)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![Bun](https://img.shields.io/badge/runtime-Bun-f9f1e1?logo=bun)](https://bun.sh)
+
+</div>
+
+## What it does
+
+Orbit MCP turns any AI coding agent (Claude, Cursor, Codex, …) into an Orbit-aware collaborator. It exposes:
+
+| Capability | Tools / Resources | Purpose |
+|---|---|---|
+| **Knowledge** | `orbit_knowledge_topics`, `orbit_knowledge_read`, `orbit://knowledge/*` | Module/controller/DI/GraphQL/microservices patterns, package map, security checklist |
+| **Scaffolding** | `orbit_scaffold_module`, `orbit_scaffold_graphql` | Generate complete feature modules with validation, guards, and tests |
+| **Security review** | `orbit_security_review` | Static checklist against pasted code — missing validation, guards, rate limits, GraphQL limits, hardcoded secrets, unsanitized HTML |
+| **Prompts** | `build_orbit_feature`, `harden_graphql_api`, `migrate_from_nestjs` | Ready-made task prompts for agents |
+
+## Quick start
+
+Add to your agent's MCP config:
+
+```json
+{
+  "mcpServers": {
+    "orbit": {
+      "command": "bunx",
+      "args": ["@galaxy-stack/orbit-mcp"]
+    }
+  }
+}
+```
 
-## Installation
+Or run directly from a checkout:
 
-```bash
-bun add @galaxy-stack/orbit-mcp
+```sh
+bun run src/server.ts
 ```
+
+## Example session
+
+> **Agent:** List what you know about Orbit.
+>
+> `orbit_knowledge_topics` →
+> `- module-pattern — Module pattern: Organize features into @Module classes…`
+> `- security-checklist — Security checklist: Helmet headers, CSRF, rate limiting…`
+> `…`
+
+> **Agent:** Review this controller for security issues.
+>
+> `orbit_security_review` with the pasted code →
+> `1. [HIGH] Mutation endpoints lack input validation. Add ValidationPipe with a Zod schema…`
+> `2. [HIGH] State-changing endpoint without an auth guard…`
+
+## Companion skill
+
+The [`skills/orbit-framework/SKILL.md`](skills/orbit-framework/SKILL.md) file is a
+portable skill definition covering the same guidance for agents that prefer
+skills over MCP. Copy it into your agent's skills directory or reference it in
+your prompt.
+
+## Protocol
+
+Implements MCP `2025-03-26` over stdio (newline-delimited JSON-RPC 2.0):
+`initialize`, `ping`, `tools/list`, `tools/call`, `resources/list`,
+`resources/read`, `prompts/list`, `prompts/get`. Zero runtime dependencies —
+runs under Bun or Node >= 18.
+
+## License
+
+MIT

package/dist/cli.js

@@ -288,9 +288,9 @@ function executeTool(name, args) {
 ${entry.content}`);
     }
     case "orbit_scaffold_module": {
-      const name2 = String(args.name || "feature");
-      const kebab = name2.replace(/([a-z0-9])([A-Z])/g, "$1-$2").toLowerCase();
-      const cls = pascal(name2);
+      const name = String(args.name || "feature");
+      const kebab = name.replace(/([a-z0-9])([A-Z])/g, "$1-$2").toLowerCase();
+      const cls = pascal(name);
       const files = [];
       files.push(`// src/${kebab}/${kebab}.module.ts
 import { Module } from '@galaxy-stack/orbit-core';
@@ -364,9 +364,9 @@ describe('${cls}Service', () => {
 `));
     }
     case "orbit_scaffold_graphql": {
-      const name2 = String(args.name || "feature");
-      const kebab = name2.replace(/([a-z0-9])([A-Z])/g, "$1-$2").toLowerCase();
-      const cls = pascal(name2);
+      const name = String(args.name || "feature");
+      const kebab = name.replace(/([a-z0-9])([A-Z])/g, "$1-$2").toLowerCase();
+      const cls = pascal(name);
       const loader = args.withLoaders ? `
   @ResolveField(() => Author)
   author(@Parent() parent: ${cls}, @Loader('authorLoader') loader: DataLoader) {
@@ -616,8 +616,8 @@ if (import.meta.main) {
   });
 }
 export {
-  serveStdio,
-  handleRequest,
+  PROTOCOL_VERSION,
   SERVER_INFO,
-  PROTOCOL_VERSION
+  handleRequest,
+  serveStdio
 };

package/dist/index.js

@@ -291,9 +291,9 @@ function executeTool(name, args) {
 ${entry.content}`);
     }
     case "orbit_scaffold_module": {
-      const name2 = String(args.name || "feature");
-      const kebab = name2.replace(/([a-z0-9])([A-Z])/g, "$1-$2").toLowerCase();
-      const cls = pascal(name2);
+      const name = String(args.name || "feature");
+      const kebab = name.replace(/([a-z0-9])([A-Z])/g, "$1-$2").toLowerCase();
+      const cls = pascal(name);
       const files = [];
       files.push(`// src/${kebab}/${kebab}.module.ts
 import { Module } from '@galaxy-stack/orbit-core';
@@ -367,9 +367,9 @@ describe('${cls}Service', () => {
 `));
     }
     case "orbit_scaffold_graphql": {
-      const name2 = String(args.name || "feature");
-      const kebab = name2.replace(/([a-z0-9])([A-Z])/g, "$1-$2").toLowerCase();
-      const cls = pascal(name2);
+      const name = String(args.name || "feature");
+      const kebab = name.replace(/([a-z0-9])([A-Z])/g, "$1-$2").toLowerCase();
+      const cls = pascal(name);
       const loader = args.withLoaders ? `
   @ResolveField(() => Author)
   author(@Parent() parent: ${cls}, @Loader('authorLoader') loader: DataLoader) {
@@ -614,12 +614,12 @@ async function serveStdio(input = process.stdin, output = process.stdout) {
 }
 if (false) {}
 export {
-  serveStdio,
-  handleRequest,
-  getKnowledge,
-  executeTool,
-  TOOLS,
-  SERVER_INFO,
+  KNOWLEDGE,
   PROTOCOL_VERSION,
-  KNOWLEDGE
+  SERVER_INFO,
+  TOOLS,
+  executeTool,
+  getKnowledge,
+  handleRequest,
+  serveStdio
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@galaxy-stack/orbit-mcp",
-  "version": "0.1.0",
-  "description": "Model Context Protocol server for Orbit framework \u2014 AI coding agents get framework knowledge, scaffolding, and security review tools",
+  "version": "0.1.2",
+  "description": "Model Context Protocol server for Orbit framework — AI coding agents get framework knowledge, scaffolding, and security review tools",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "bin": {
@@ -29,12 +29,14 @@
     "bun",
     "nestjs-style"
   ],
-  "dependencies": {},
+  "dependencies": {
+    "@smithery/api": "^0.68.0"
+  },
   "devDependencies": {
+    "@changesets/cli": "^2.27.0",
     "@types/bun": "latest",
-    "typescript": "^5.0.0",
     "reflect-metadata": "^0.2.2",
-    "@changesets/cli": "^2.27.0"
+    "typescript": "^5.0.0"
   },
   "author": "Orbit Team",
   "license": "MIT",