@galaxy-stack/orbit-mcp 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +73 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,9 +1,78 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
1
3
|
# @galaxy-stack/orbit-mcp
|
|
2
4
|
|
|
3
|
-
|
|
5
|
+
**Model Context Protocol server for the Orbit framework**
|
|
6
|
+
|
|
7
|
+
Give AI coding agents first-class knowledge of Orbit: framework patterns, code scaffolding, and security review — through the [Model Context Protocol](https://modelcontextprotocol.io).
|
|
8
|
+
|
|
9
|
+
[](https://www.npmjs.com/package/@galaxy-stack/orbit-mcp)
|
|
10
|
+
[](LICENSE)
|
|
11
|
+
[](https://bun.sh)
|
|
12
|
+
|
|
13
|
+
</div>
|
|
14
|
+
|
|
15
|
+
## What it does
|
|
16
|
+
|
|
17
|
+
Orbit MCP turns any AI coding agent (Claude, Cursor, Codex, …) into an Orbit-aware collaborator. It exposes:
|
|
18
|
+
|
|
19
|
+
| Capability | Tools / Resources | Purpose |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| **Knowledge** | `orbit_knowledge_topics`, `orbit_knowledge_read`, `orbit://knowledge/*` | Module/controller/DI/GraphQL/microservices patterns, package map, security checklist |
|
|
22
|
+
| **Scaffolding** | `orbit_scaffold_module`, `orbit_scaffold_graphql` | Generate complete feature modules with validation, guards, and tests |
|
|
23
|
+
| **Security review** | `orbit_security_review` | Static checklist against pasted code — missing validation, guards, rate limits, GraphQL limits, hardcoded secrets, unsanitized HTML |
|
|
24
|
+
| **Prompts** | `build_orbit_feature`, `harden_graphql_api`, `migrate_from_nestjs` | Ready-made task prompts for agents |
|
|
25
|
+
|
|
26
|
+
## Quick start
|
|
27
|
+
|
|
28
|
+
Add to your agent's MCP config:
|
|
29
|
+
|
|
30
|
+
```json
|
|
31
|
+
{
|
|
32
|
+
"mcpServers": {
|
|
33
|
+
"orbit": {
|
|
34
|
+
"command": "bunx",
|
|
35
|
+
"args": ["@galaxy-stack/orbit-mcp"]
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
```
|
|
4
40
|
|
|
5
|
-
|
|
41
|
+
Or run directly from a checkout:
|
|
6
42
|
|
|
7
|
-
```
|
|
8
|
-
bun
|
|
43
|
+
```sh
|
|
44
|
+
bun run src/server.ts
|
|
9
45
|
```
|
|
46
|
+
|
|
47
|
+
## Example session
|
|
48
|
+
|
|
49
|
+
> **Agent:** List what you know about Orbit.
|
|
50
|
+
>
|
|
51
|
+
> `orbit_knowledge_topics` →
|
|
52
|
+
> `- module-pattern — Module pattern: Organize features into @Module classes…`
|
|
53
|
+
> `- security-checklist — Security checklist: Helmet headers, CSRF, rate limiting…`
|
|
54
|
+
> `…`
|
|
55
|
+
|
|
56
|
+
> **Agent:** Review this controller for security issues.
|
|
57
|
+
>
|
|
58
|
+
> `orbit_security_review` with the pasted code →
|
|
59
|
+
> `1. [HIGH] Mutation endpoints lack input validation. Add ValidationPipe with a Zod schema…`
|
|
60
|
+
> `2. [HIGH] State-changing endpoint without an auth guard…`
|
|
61
|
+
|
|
62
|
+
## Companion skill
|
|
63
|
+
|
|
64
|
+
The [`skills/orbit-framework/SKILL.md`](skills/orbit-framework/SKILL.md) file is a
|
|
65
|
+
portable skill definition covering the same guidance for agents that prefer
|
|
66
|
+
skills over MCP. Copy it into your agent's skills directory or reference it in
|
|
67
|
+
your prompt.
|
|
68
|
+
|
|
69
|
+
## Protocol
|
|
70
|
+
|
|
71
|
+
Implements MCP `2025-03-26` over stdio (newline-delimited JSON-RPC 2.0):
|
|
72
|
+
`initialize`, `ping`, `tools/list`, `tools/call`, `resources/list`,
|
|
73
|
+
`resources/read`, `prompts/list`, `prompts/get`. Zero runtime dependencies —
|
|
74
|
+
runs under Bun or Node >= 18.
|
|
75
|
+
|
|
76
|
+
## License
|
|
77
|
+
|
|
78
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@galaxy-stack/orbit-mcp",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "Model Context Protocol server for Orbit framework — AI coding agents get framework knowledge, scaffolding, and security review tools",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|