mcp-software-design 0.1.2 → 0.1.3
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 +6 -16
- package/build/catalog.js +23 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -7,11 +7,12 @@
|
|
|
7
7
|
|
|
8
8
|
An [MCP](https://modelcontextprotocol.io) server that teaches and helps apply
|
|
9
9
|
**software-design guidance** — the SOLID principles, the OOP pillars, DRY /
|
|
10
|
-
KISS / YAGNI / meaningful naming, and the 23 Gang-of-Four design
|
|
10
|
+
KISS / YAGNI / meaningful naming / clean code, and the 23 Gang-of-Four design
|
|
11
|
+
patterns —
|
|
11
12
|
plus pattern scaffolding and heuristic code-smell detection.
|
|
12
13
|
|
|
13
14
|
It's the companion to
|
|
14
|
-
[`mcp-udacity-commit`](
|
|
15
|
+
[`mcp-udacity-commit`](https://github.com/qwertymuzaffar/mcp-udacity-commit): same stack (TypeScript, the MCP
|
|
15
16
|
SDK, stdio transport), same shape (pure logic modules + thin server wiring).
|
|
16
17
|
|
|
17
18
|
## Install
|
|
@@ -101,25 +102,14 @@ npm test # builds, then runs the unit tests
|
|
|
101
102
|
npm run test:client # end-to-end check against the built server
|
|
102
103
|
```
|
|
103
104
|
|
|
104
|
-
Then register the
|
|
105
|
+
Then register it the same way as [Install](#install) above — both the
|
|
106
|
+
`claude mcp add` command and the MCP-client-config form work — but point at
|
|
107
|
+
your local build instead of `npx`:
|
|
105
108
|
|
|
106
109
|
```bash
|
|
107
110
|
claude mcp add software-design -- node /absolute/path/to/mcp-software-design/build/index.js
|
|
108
111
|
```
|
|
109
112
|
|
|
110
|
-
Or in an MCP client config:
|
|
111
|
-
|
|
112
|
-
```json
|
|
113
|
-
{
|
|
114
|
-
"mcpServers": {
|
|
115
|
-
"software-design": {
|
|
116
|
-
"command": "node",
|
|
117
|
-
"args": ["/absolute/path/to/mcp-software-design/build/index.js"]
|
|
118
|
-
}
|
|
119
|
-
}
|
|
120
|
-
}
|
|
121
|
-
```
|
|
122
|
-
|
|
123
113
|
## Layout
|
|
124
114
|
|
|
125
115
|
```
|
package/build/catalog.js
CHANGED
|
@@ -189,6 +189,29 @@ export const PRINCIPLES = [
|
|
|
189
189
|
],
|
|
190
190
|
related: ["kiss", "single-responsibility", "separation-of-concerns"],
|
|
191
191
|
},
|
|
192
|
+
{
|
|
193
|
+
slug: "clean-code",
|
|
194
|
+
name: "Clean Code",
|
|
195
|
+
category: "principle",
|
|
196
|
+
aka: ["readability", "craftsmanship"],
|
|
197
|
+
summary: "Code is read far more than it's written — optimize for the reader.",
|
|
198
|
+
intent: "Clean Code is an umbrella habit, not a single rule: write code a later " +
|
|
199
|
+
"reader (usually you) can understand quickly and change safely. It's the " +
|
|
200
|
+
"sum of the concrete principles here — intention-revealing names, small " +
|
|
201
|
+
"single-purpose units, no duplication, and the simplest thing that works — " +
|
|
202
|
+
"rather than a separate technique of its own.",
|
|
203
|
+
whenToUse: [
|
|
204
|
+
"You hesitate to touch a file because you don't understand it.",
|
|
205
|
+
"Reviewers keep asking 'what does this do?' about the same code.",
|
|
206
|
+
"Reading the change takes longer than making it.",
|
|
207
|
+
],
|
|
208
|
+
tradeoffs: [
|
|
209
|
+
"'Clean' is contextual — a throwaway script and a core library deserve different bars.",
|
|
210
|
+
"Endless renaming/extracting has diminishing returns; stop once it reads clearly.",
|
|
211
|
+
"Cleanliness is not correctness — clean code can still be wrong; tests decide behavior.",
|
|
212
|
+
],
|
|
213
|
+
related: ["meaningful-names", "single-responsibility", "dry", "kiss"],
|
|
214
|
+
},
|
|
192
215
|
{
|
|
193
216
|
slug: "composition-over-inheritance",
|
|
194
217
|
name: "Composition Over Inheritance",
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "mcp-software-design",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.3",
|
|
4
4
|
"description": "MCP server that teaches and applies software-design guidance: SOLID/OOP/DRY principles, the 23 GoF design patterns, pattern scaffolding, and heuristic code-smell detection.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|