@h2nguyen/arc42-node-mcp-server 2.1.1 → 2.2.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.
Files changed (3) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/README.md +76 -0
  3. package/package.json +12 -2
package/CHANGELOG.md CHANGED
@@ -5,6 +5,26 @@ All notable changes to the arc42 MCP Server will be documented in this file.
5
5
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
6
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
7
 
8
+ ## [2.2.0] - 2026-03-09
9
+
10
+ ### Added
11
+ - **Claude Skill for Arc42**: Pre-built Claude skill (`.claude/skills/arc42-docs-mcp/`) that teaches Claude how to effectively use the arc42 MCP server tools
12
+ - `SKILL.md` with workflows, tool reference, and behavioral guidelines
13
+ - Reference documents for setup and practical usage examples (8 scenarios)
14
+ - Can be copied or symlinked into other projects for automatic arc42 documentation assistance
15
+ - **Project CLAUDE.md**: Added project-level instructions for Claude Code with build commands, code conventions, architecture overview, and key constraints
16
+ - **Dependency Review Configuration**: Added `.github/dependency-review-config.yml` with allowed license list (Apache-2.0, MIT, ISC, BSD, CC-BY-SA-4.0, CC0-1.0, 0BSD)
17
+
18
+ ### Changed
19
+ - Updated license metadata in `package.json` to SPDX expression `(Apache-2.0 AND CC-BY-SA-4.0)` with explicit dual-license entries for Apache-2.0 (code) and CC-BY-SA-4.0 (arc42 template content)
20
+
21
+ ### Security
22
+ - Bump `express-rate-limit` from 8.2.1 to 8.3.1 in the npm_and_yarn group
23
+ - Bump `hono` from 4.12.3 to 4.12.5 and `@hono/node-server` from 1.19.9 to 1.19.10
24
+
25
+ ### Documentation
26
+ - Added "Claude Skill for Arc42" section to README with installation instructions, skill triggers, and benefits comparison table
27
+
8
28
  ## [2.1.1] - 2026-02-26
9
29
 
10
30
  ### Security
package/README.md CHANGED
@@ -49,6 +49,11 @@ A Model Context Protocol (MCP) server that helps you create comprehensive archit
49
49
  * [🎯 Best Practices](#-best-practices)
50
50
  * [For AI Assistants](#for-ai-assistants)
51
51
  * [For Users](#for-users)
52
+ * [🧠 Claude Skill for Arc42](#-claude-skill-for-arc42)
53
+ * [What Is the Arc42 Skill?](#what-is-the-arc42-skill)
54
+ * [Installing the Skill in Other Projects](#installing-the-skill-in-other-projects)
55
+ * [Skill Triggers](#skill-triggers)
56
+ * [Benefits for Your Projects](#benefits-for-your-projects)
52
57
  * [🔧 Development](#-development)
53
58
  * [Development Methodology](#development-methodology)
54
59
  * [Documentation Quality Assurance](#documentation-quality-assurance)
@@ -705,6 +710,77 @@ your-project/
705
710
  4. **Keep it current**: Update as architecture evolves
706
711
  5. **Use version control**: Commit your arc42-docs directory to Git
707
712
 
713
+ ## 🧠 Claude Skill for Arc42
714
+
715
+ This project includes a pre-built **Claude Skill** that teaches Claude (via [Claude Code](https://docs.anthropic.com/en/docs/claude-code) or any skill-aware Claude integration) how to effectively use the arc42 MCP server tools for architecture documentation — without manual prompting.
716
+
717
+ ### What Is the Arc42 Skill?
718
+
719
+ The skill is a structured knowledge package located at `.claude/skills/arc42-docs-mcp/` containing:
720
+
721
+ ```
722
+ .claude/skills/arc42-docs-mcp/
723
+ ├── SKILL.md # Skill definition with workflows, tool reference, and behavioral guidelines
724
+ └── references/
725
+ ├── setup.md # MCP server installation and configuration for all clients
726
+ └── examples.md # Practical usage examples (8 scenarios)
727
+ ```
728
+
729
+ When present in a project, Claude automatically loads the skill and understands:
730
+
731
+ - The correct **workflow order** for arc42 documentation (guide → init → status → template → write → review)
732
+ - **All 6 MCP tools**, their parameters, and expected responses
733
+ - **Best practices** such as always generating a template before writing, using append mode for ADRs, and asking clarifying questions before assuming project details
734
+ - The **recommended documentation order** (Section 1 → 3 → 4 → 5 → 9, then fill the remaining sections)
735
+
736
+ ### Installing the Skill in Other Projects
737
+
738
+ To enable the arc42 skill in any project where Claude Code is used:
739
+
740
+ **Option 1: Copy the skill directory**
741
+
742
+ ```bash
743
+ # From your project root
744
+ mkdir -p .claude/skills
745
+ cp -r /path/to/Arc42-Node-MCP-Server/.claude/skills/arc42-docs-mcp .claude/skills/
746
+ ```
747
+
748
+ **Option 2: Symlink (keeps the skill up-to-date)**
749
+
750
+ ```bash
751
+ # From your project root
752
+ mkdir -p .claude/skills
753
+ ln -s /path/to/Arc42-Node-MCP-Server/.claude/skills/arc42-docs-mcp .claude/skills/arc42-docs-mcp
754
+ ```
755
+
756
+ > **Prerequisite**: The arc42 MCP server must also be configured in your project's MCP settings (`.mcp.json`, Claude Desktop config, etc.). The skill teaches Claude *how* to use the tools, but the MCP server must be running to provide them. See [Setup in Claude Desktop](#setup-in-claude-desktop), [Setup in Cursor](#setup-in-cursor), or [Setup in Cline](#setup-in-cline) for server configuration.
757
+
758
+ After installation, commit the `.claude/skills/arc42-docs-mcp/` directory to version control so all team members benefit from the skill automatically.
759
+
760
+ ### Skill Triggers
761
+
762
+ Claude activates the arc42 skill when it detects any of the following in conversation:
763
+
764
+ | Trigger | Examples |
765
+ |-------------------------------------|----------------------------------------------------------------------------------------------|
766
+ | Architecture documentation keywords | "create architecture documentation", "document the architecture", "update architecture docs" |
767
+ | Arc42 references | "arc42", "initialize arc42", "arc42 template" |
768
+ | Section-specific requests | "document the deployment view", "add quality requirements", "describe the building blocks" |
769
+ | ADR mentions | "add an Architecture Decision Record", "document why we chose PostgreSQL" |
770
+ | Any of the 12 arc42 sections | Introduction and Goals, Constraints, Context and Scope, Solution Strategy, etc. |
771
+
772
+ ### Benefits for Your Projects
773
+
774
+ | Benefit | Without Skill | With Skill |
775
+ |------------------------|---------------------------------------------------|-----------------------------------------------------------------------------------|
776
+ | **Workflow knowledge** | Must manually prompt Claude to follow arc42 order | Claude automatically follows guide → init → template → write workflow |
777
+ | **Tool usage** | May call tools incorrectly or skip steps | Calls the right tools with correct parameters in the right sequence |
778
+ | **Content quality** | Generic documentation output | Generates templates first, asks clarifying questions, documents WHY not just WHAT |
779
+ | **ADR handling** | Risk of overwriting existing decisions | Always reads existing ADRs first and uses append mode |
780
+ | **Format awareness** | May mix AsciiDoc and Markdown syntax | Checks `arc42-status` for configured format and writes consistently |
781
+ | **Multi-language** | Defaults to English only | Respects configured language across all tool calls |
782
+ | **Team consistency** | Each developer gets different results | Shared skill in version control ensures consistent documentation quality |
783
+
708
784
  ## 🔧 Development
709
785
 
710
786
  ### Development Methodology
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@h2nguyen/arc42-node-mcp-server",
3
- "version": "2.1.1",
3
+ "version": "2.2.0",
4
4
  "description": "MCP server for arc42 architecture documentation - AI-assisted architecture documentation following arc42 template",
5
5
  "main": "dist/index.js",
6
6
  "type": "module",
@@ -44,7 +44,17 @@
44
44
  "email": "me@viethainguyen.de",
45
45
  "url": "https://github.com/h2nguyen"
46
46
  },
47
- "license": "Apache-2.0",
47
+ "license": "(Apache-2.0 AND CC-BY-SA-4.0)",
48
+ "licenses": [
49
+ {
50
+ "type": "Apache-2.0",
51
+ "url": "https://github.com/h2nguyen/Arc42-Node-MCP-Server/blob/main/LICENSE"
52
+ },
53
+ {
54
+ "type": "CC-BY-SA-4.0",
55
+ "url": "https://github.com/h2nguyen/Arc42-Node-MCP-Server/blob/main/LICENSE-ARC42"
56
+ }
57
+ ],
48
58
  "repository": {
49
59
  "type": "git",
50
60
  "url": "https://github.com/h2nguyen/Arc42-Node-MCP-Server.git"