raven-mcp 1.3.5 → 1.4.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/NOTICE ADDED
@@ -0,0 +1,101 @@
1
+ Raven MCP
2
+ Copyright (c) 2026 Andrew Cunliffe
3
+
4
+ Licensed under the MIT License — see LICENSE for full text.
5
+
6
+ This is a personal open-source project. It is not endorsed by, affiliated with,
7
+ or supported by Intuit Inc. or any other company referenced in the source data.
8
+
9
+ ================================================================================
10
+ Third-party sources referenced in src/data/
11
+ ================================================================================
12
+
13
+ Raven's knowledge base paraphrases, summarizes, and references the work of many
14
+ authors and organizations. Source URLs are embedded in each entry's `sources`
15
+ field. Several upstream sources carry their own licenses — listed below in
16
+ descending order of permissiveness.
17
+
18
+ Permissive / public-domain sources
19
+ ----------------------------------
20
+ - Gestalt principles — early-20th-century academic work, public domain.
21
+ Descriptions in Raven are original prose.
22
+
23
+ - W3C Web Content Accessibility Guidelines (WCAG 2.1 / 2.2)
24
+ https://www.w3.org/WAI/standards-guidelines/wcag/
25
+ Licensed under the W3C Document License. Permits redistribution and
26
+ derivative works with attribution.
27
+
28
+ - GOV.UK Style Guide and GOV.UK Service Standard
29
+ https://www.gov.uk/guidance/style-guide
30
+ https://www.gov.uk/service-manual/service-standard
31
+ Contains public sector information licensed under the Open Government
32
+ Licence v3.0: https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/
33
+
34
+ - Shopify Polaris (component library)
35
+ https://polaris.shopify.com — Polaris code is MIT-licensed. Content
36
+ documentation is paraphrased as reference; consult Shopify for the
37
+ authoritative version.
38
+
39
+ Attribution-with-conditions sources
40
+ -----------------------------------
41
+ - Nielsen's 10 Usability Heuristics, Nielsen Norman Group
42
+ https://www.nngroup.com/articles/ten-usability-heuristics/
43
+ Heuristic names are short factual labels; Raven's descriptions are original
44
+ paraphrase under fair-use commentary. NN/g is the canonical source for
45
+ production use.
46
+
47
+ - Laws of UX, Jon Yablonski
48
+ https://lawsofux.com — licensed under CC BY-NC-ND 4.0.
49
+ Raven references the named laws (Fitts's Law, Miller's Law, Hick's Law,
50
+ etc. — which are public academic concepts) and provides original
51
+ descriptions. No prose from lawsofux.com is reproduced. The named "21
52
+ Laws of UX" framing and any Yablonski-authored summaries are the
53
+ property of the original author; consult lawsofux.com for the canonical
54
+ versions.
55
+
56
+ - Mailchimp Content Style Guide
57
+ https://styleguide.mailchimp.com — licensed under CC BY-NC 4.0.
58
+ Raven's mailchimp.json is a paraphrased reference to the publicly
59
+ documented voice attributes, tone shifts, and content patterns.
60
+ Consult the original for authoritative or commercial use.
61
+
62
+ - Atlassian Design System
63
+ https://atlassian.design — content paraphrased as reference; no
64
+ Atlassian copy is reproduced verbatim.
65
+
66
+ - This Is Service Design Doing (Stickdorn, Hormess, Lawrence, Schneider),
67
+ O'Reilly 2018 — five service-design principles are referenced as
68
+ concepts; descriptions are original.
69
+
70
+ - Lynn Shostack, "How to Design a Service" / "Designing Services That
71
+ Deliver" (Harvard Business Review, 1984) — service-blueprinting concept
72
+ is referenced; descriptions are original.
73
+
74
+ Frameworks (concept-only, no copyrighted prose)
75
+ -----------------------------------------------
76
+ - HEART framework (Kerry Rodden, Hilary Hutchinson, Xin Fu — Google, 2010)
77
+ - AARRR / Pirate Metrics (Dave McClure, 500 Startups, 2007)
78
+ - North Star Metric (Sean Ellis / Amplitude)
79
+ - RICE prioritization (Intercom)
80
+ - OKRs (Andy Grove / John Doerr)
81
+ - Carlzon's Moments of Truth (Jan Carlzon, 1987)
82
+
83
+ These are methodological frameworks; concepts are not copyrightable.
84
+ Descriptions in Raven are original.
85
+
86
+ Design tokens
87
+ -------------
88
+ Token values (color hex codes, type scales, spacing units, motion timings)
89
+ for the design systems referenced in src/data/tokens/ are functional values
90
+ extracted from publicly accessible design-system documentation. Functional
91
+ design values are not protectable expression. Brand names are used
92
+ nominatively to label which system a token set is styled like, not to
93
+ suggest endorsement.
94
+
95
+ ================================================================================
96
+ Removing a source
97
+ ================================================================================
98
+
99
+ If you are a rights-holder and would like a source removed, amended, or
100
+ attributed differently, file an issue at:
101
+ https://github.com/rhinocap/raven-mcp/issues
package/README.md CHANGED
@@ -4,13 +4,15 @@
4
4
 
5
5
  A design knowledge MCP server that Claude can query when generating UI. Eight layers: principles, patterns, content design systems, research methods, service design, brand/visual, business strategy, and design tokens.
6
6
 
7
+ > Raven MCP is a personal open-source project by [Andrew Cunliffe](https://ravenmcp.ai). It is **not endorsed by, affiliated with, or supported by Intuit Inc.** or any other company referenced in its source data. See [NOTICE](./NOTICE) for full attribution of upstream sources and their licenses.
8
+
7
9
  ## What it does
8
10
 
9
11
  Raven gives Claude access to a comprehensive design knowledge base:
10
12
 
11
13
  - **Principles** — Nielsen's 10 Heuristics, all 21 Laws of UX, Gestalt principles, WCAG accessibility, typography rules, color theory, mobile UX, D4D framework, UX writing, service design, and brand
12
14
  - **Patterns** — Proven UI patterns for signup flows, pricing pages, navigation, forms, landing pages, dashboards, modals, empty/error/loading states, CTAs, social proof, mobile conversion — plus content patterns (error messages, empty-state copy, notifications, form validation) and service patterns (service blueprinting, human handoff, signup-as-service, omnichannel continuity, moments of truth)
13
- - **Content systems** — Voice & tone guides from real brands: Mailchimp, GOV.UK, Shopify Polaris, Atlassian, and Intuit
15
+ - **Content systems** — Voice & tone guides from publicly documented brand systems: Mailchimp, GOV.UK, Shopify Polaris, and Atlassian
14
16
  - **Research** — Qualitative, quantitative, and usability methods with do/don't protocols and checklists. Metrics frameworks: HEART, AARRR/Pirate, North Star Metric, conversion funnel, RICE, OKRs.
15
17
  - **Service design** — Service blueprinting (with HTML blueprint generation — current vs. ideal state), human-handoff patterns, signup-as-service, omnichannel continuity, moments of truth / recovery, and the GOV.UK Service Standard
16
18
  - **Brand & visual** — Logo usage (clear space, min sizes, variants, placement, restraint), gradient usage (hierarchy, palette, contrast, trend vs signature), imagery (consistency, representation, purpose), visual hierarchy, brand-as-system, and current (2026) visual-design trends
@@ -63,7 +65,7 @@ cd raven-mcp && npm install && npm run build
63
65
  | `audit_page` | Audit HTML/CSS against Raven's quality standards |
64
66
  | `audit_layout` | Evaluate visual rhythm, alignment, and optical balance |
65
67
  | `generate_design_system` | Generate a custom design system from a brand color |
66
- | `list_content_systems` | Browse brand voice & tone systems (Mailchimp, GOV.UK, Shopify Polaris, Atlassian, Intuit) |
68
+ | `list_content_systems` | Browse brand voice & tone systems (Mailchimp, GOV.UK, Shopify Polaris, Atlassian) |
67
69
  | `get_content_system` | Get a brand's voice attributes, tone shifts, vocabulary, grammar, and content patterns |
68
70
  | `get_content_principles` | Get UX-writing principles — clarity, active voice, error anatomy, inclusive language |
69
71
  | `get_content_pattern` | Get copy recipes for error messages, empty-state copy, notifications, form validation |
@@ -105,6 +107,16 @@ npm run build # Compile TypeScript
105
107
  npm start # Run compiled output
106
108
  ```
107
109
 
110
+ ## License & attribution
111
+
112
+ Raven MCP is released under the [MIT License](./LICENSE) — Copyright (c) 2026 Andrew Cunliffe.
113
+
114
+ If you fork, embed, or redistribute Raven (in whole or in part), retain the MIT license notice and the `LICENSE` file. If you ship Raven inside another product, include attribution to "Raven MCP — https://ravenmcp.ai" in your acknowledgements.
115
+
116
+ Raven's knowledge base paraphrases and references work from many third-party sources — Nielsen Norman Group, Laws of UX (CC BY-NC-ND 4.0), Gestalt principles, WCAG (W3C), Mailchimp (CC BY-NC 4.0), GOV.UK (Open Government Licence v3.0), Shopify Polaris, Atlassian Design, and others. Each entry carries a `sources` URL field. See [NOTICE](./NOTICE) for the full list of upstream sources and license terms; some carry their own conditions beyond MIT.
117
+
118
+ This is a personal project. It is not endorsed by Intuit Inc. or any other company referenced in its source data.
119
+
108
120
  ## Data structure
109
121
 
110
122
  All knowledge lives in `src/data/` as static JSON files:
@@ -115,8 +127,8 @@ src/data/
115
127
  patterns/ # signup, pricing, nav, forms, landing, dashboard, modals, empty/error/loading, CTA, social proof, mobile
116
128
  business/ # monetization, retention, onboarding, growth, metrics
117
129
  tokens/ # registry.json + systems/ (stripe, linear, vercel, …)
118
- content/ # voice & tone: Mailchimp, GOV.UK, Shopify Polaris, Atlassian, Intuit
119
- systems/ # registry.json + brand-voice JSONs
130
+ content/ # voice & tone: Mailchimp, GOV.UK, Shopify Polaris, Atlassian
131
+ systems/ # registry.json + brand-voice JSONs (Mailchimp, GOV.UK, Polaris, Atlassian)
120
132
  principles/ # UX-writing principles (clarity, active voice, error anatomy, …)
121
133
  patterns/ # copy recipes for errors, empty states, notifications, form validation
122
134
  research/ # study protocols + metrics frameworks
package/dist/index.js CHANGED
@@ -2421,7 +2421,7 @@ server.tool("audit_layout", "Evaluate visual rhythm from a rendered page's geome
2421
2421
  // principles and patterns are loaded into the regular principles/pattern
2422
2422
  // arrays and reachable through get_principles/get_pattern as well — these
2423
2423
  // tools are the discoverable shortcuts.
2424
- server.tool("list_content_systems", "Browse available content design systems — brand voice and tone guides from real companies (Mailchimp, GOV.UK, Shopify Polaris, Atlassian, Intuit). Filter by category or search by name.", {
2424
+ server.tool("list_content_systems", "Browse available content design systems — brand voice and tone guides from real companies (Mailchimp, GOV.UK, Shopify Polaris, Atlassian). Filter by category or search by name.", {
2425
2425
  category: z.string().optional().describe("Filter by category: marketing-saas, government, commerce-saas, productivity-saas, fintech"),
2426
2426
  search: z.string().optional().describe("Search by name, description, or tag")
2427
2427
  }, async ({ category, search }) => {
@@ -2449,7 +2449,7 @@ server.tool("list_content_systems", "Browse available content design systems —
2449
2449
  };
2450
2450
  });
2451
2451
  server.tool("get_content_system", "Get a brand's content design system — voice attributes, tone shifts by context, vocabulary (use/avoid/never), grammar rules, content patterns for errors/empty-states/buttons/etc., and inclusive language guidance.", {
2452
- id: z.string().describe("Content system ID (e.g. 'mailchimp', 'gov-uk', 'shopify-polaris', 'atlassian', 'intuit')"),
2452
+ id: z.string().describe("Content system ID (e.g. 'mailchimp', 'gov-uk', 'shopify-polaris', 'atlassian')"),
2453
2453
  section: z.enum(["all", "voice", "tone_shifts", "vocabulary", "grammar", "content-patterns", "inclusive-language"]).optional().describe("Return just one section. Default: all.")
2454
2454
  }, async ({ id, section }) => {
2455
2455
  var sys = loadContentSystem(id);