@beebear-plugins/mcp 0.0.0-stage → 0.1.0

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 CHANGED
@@ -1,3 +1,86 @@
1
- # Temporary Holding Version
1
+ # @beebear-plugins/mcp
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ MCP (Model Context Protocol) server that teaches AI coding assistants how to use [beebear](https://github.com/nishantCoding/beebear) — the hexagonal architecture framework for Node.js/TypeScript.
4
+
5
+ ## What It Does
6
+
7
+ AI assistants don't know beebear. They'll generate decorator-heavy code, skip `Port<T>()` tokens, put logic in adapters, and miss error mapping. This MCP server fixes that by providing:
8
+
9
+ - **8 Resources** — Documentation on beebear's API, patterns, project structure, errors, HTTP adapters, decorators plugin, and DDD plugin
10
+ - **10 Tools** — Code scaffold generators for ports, use cases, adapters, routes, container setup, DDD building blocks, and decorator setup
11
+ - **2 Prompts** — Guided workflows for creating new projects and adding features
12
+
13
+ ## Installation
14
+
15
+ ```bash
16
+ npm install -g @beebear-plugins/mcp
17
+ ```
18
+
19
+ ## Usage
20
+
21
+ ### With Claude Desktop
22
+
23
+ Add to your `claude_desktop_config.json`:
24
+
25
+ ```json
26
+ {
27
+ "mcpServers": {
28
+ "beebear": {
29
+ "command": "beebear-mcp"
30
+ }
31
+ }
32
+ }
33
+ ```
34
+
35
+ ### With Claude Code
36
+
37
+ ```bash
38
+ claude mcp add beebear-mcp -- beebear-mcp
39
+ ```
40
+
41
+ ### With any MCP client
42
+
43
+ The server runs on stdio transport:
44
+
45
+ ```bash
46
+ beebear-mcp
47
+ ```
48
+
49
+ ## Resources
50
+
51
+ | Resource | URI | Content |
52
+ |---|---|---|
53
+ | overview | `beebear://docs/overview` | What beebear is, core concepts, plugin ecosystem |
54
+ | api | `beebear://docs/api` | Full API reference with type signatures |
55
+ | patterns | `beebear://docs/patterns` | Port definition, use cases, adapters, container binding, HTTP routes, hooks |
56
+ | project-structure | `beebear://docs/project-structure` | Standard folder layout and what goes where |
57
+ | errors | `beebear://docs/errors` | Error hierarchy, HTTP status mapping, custom errors |
58
+ | http-adapters | `beebear://docs/http-adapters` | Express/Fastify/Hono examples, custom strategies |
59
+ | decorators | `beebear://docs/decorators` | @Injectable, @Inject, withDecorators |
60
+ | ddd | `beebear://docs/ddd` | ValueObject, Entity, AggregateRoot, DomainEvent |
61
+
62
+ ## Tools
63
+
64
+ | Tool | Description |
65
+ |---|---|
66
+ | `scaffold_port` | Generate inbound (UseCase) or outbound (dependency) port |
67
+ | `scaffold_use_case` | Generate use case class implementing a driving port |
68
+ | `scaffold_adapter` | Generate adapter class implementing an outbound port |
69
+ | `scaffold_route` | Generate HTTP route with `hex.httpAdapter()` |
70
+ | `scaffold_container_setup` | Generate container bindings with `createContainer()` |
71
+ | `scaffold_entity` | Generate DDD Entity subclass |
72
+ | `scaffold_value_object` | Generate DDD ValueObject with validation |
73
+ | `scaffold_aggregate` | Generate AggregateRoot with domain events |
74
+ | `scaffold_event_publisher` | Generate EventPublisher port + transport adapter |
75
+ | `scaffold_decorator_setup` | Generate @Injectable/@Inject decorator setup |
76
+
77
+ ## Prompts
78
+
79
+ | Prompt | Args | Description |
80
+ |---|---|---|
81
+ | `new-project` | `framework` (express/fastify/hono), `name` | Step-by-step new project setup |
82
+ | `add-feature` | `featureName`, `description` | Add a feature with ports, use case, adapter, route, tests |
83
+
84
+ ## License
85
+
86
+ MIT
@@ -0,0 +1 @@
1
+ #!/usr/bin/env node