Token导航 LogoToken导航TokenDH.com
Arc42 Node MCP Server logo
开发工具stdio官方级别未说明来源级核验

Arc42 Node MCP Server

MCP Server

基于arc42模板的AI辅助架构文档生成工具,支持多语言和多格式输出,适用于软件开发团队创建和维护系统架构文档。

工具数

6

提示词数

0

GitHub Stars

1

资源数

0
开发工具TypeScriptClaude文档生成Claude DesktopClaudeCursorCline

安装说明

本站只整理中文说明和来源信息,不托管安装包,也不代用户安装。

作者 / 组织

h2nguyen

提供方

h2nguyen

最后核验

2026/5/17 20:20

运行时

Docker

快速接入

先看主来源和安装命令,再打开仓库或文档;下面只保留这个条目的关键接入事实。

命令预览

docker run -v /path/to/project:/project arc42-node-mcp-server

详细介绍

Arc42节点MCP服务器

基于arc42模板的AI辅助架构文档

一个模型上下文协议(MCP)服务器,可帮助您使用经过验证的arc42模板创建全面的架构文档。非常适合使用Claude、Cursor、Cline和其他MCP兼容工具进行人工智能辅助文档。

![License](https://opensource.org/licenses/Apache-2.0) ![TypeScript](https://www.typescriptlang.org/) ![MCP](https://modelcontextprotocol.io/)

目录

- arc42模板参考 - 更新到最新的arc42模板

- 安装 - 在Claude Desktop中设置 - 在游标中设置 - Cline中的设置 - 故障排除:NVM用户 - 了解工作区配置 - 选项1:默认工作区路径(服务器启动参数) - 选项2:动态目标文件夹参数(每个工具覆盖) - 推荐 - 第一步

- arc42工作流程指南 - arc42初始化 - arc42状态 - 生成模板 - 更新部分 - 获取部分

- 支持的语言 - 使用语言 - 语言配置

- 支持格式 - 使用格式 - 格式配置

- 示例1:重新开始 - 示例2:文档特定部分 - 示例3:添加架构决策

- AI助理 - 对于用户

- Arc42技能是什么? - 在其他项目中安装该技能 - 技能触发器 - 为您的项目带来的好处

- 开发方法论 - 文件质量保证 - 从源头构建 - 以开发模式运行

- 运行测试 - 测试结构 - 覆盖阈值 - 测试类别 - CI/CD管道

- - - - 使用MCP Inspector进行独立测试(推荐) - - 测试工作流程

📋 什么是arc42?

arc42 是架构通信和文档的模板。它为记录软件和系统架构提供了一个清晰的结构,使所有利益相关者都能理解。

此MCP服务器将arc42带入人工智能辅助开发时代,使您能够:

  • 🤖 在人工智能的帮助下生成架构文档
  • 📊 在十二个定义明确的部分中遵循经过验证的结构
  • ✅ 跟踪文档进度和完整性
  • 🔄 保持一致、最新的架构文档
  • 🌍 在全球开发团队之间共享知识

arc42模板参考

此MCP服务器从动态读取版本信息 arc42模板git子模块 在运行时。

财产价值
来源arc42/arc42模板
子模块路径vendor/arc42-template
版本文件vendor/arc42-template/EN/version.properties
备注:此服务器在以下两个方面都提供本机模板 AsciiDoc标记语言 支持所有11种语言的格式。AsciiDoc是新项目的默认格式。

要显示当前的arc42模板版本,请执行以下操作:

npm run show:arc42-version

更新到最新的arc42模板

此项目使用 动态版本加载方法:

  • Git子模块 (vendor/arc42-template)提供上游模板
  • 动态读取版本信息vendor/arc42-template/EN/version.properties 运行时
  • 没有硬编码值 -版本始终反映已签出的子模块状态

要更新到最新的arc42模板版本:

# Update submodule and display new version
npm run update:arc42

# Or manually:
npm run submodule:update       # Pull latest from upstream
npm run show:arc42-version     # Display new version info

# Review and test
npm test                       # Ensure tests pass
git diff                       # Review changes
git add vendor/arc42-template  # Stage submodule update

对于克隆repo的贡献者,初始化子模块:

git clone --recurse-submodules https://github.com/h2nguyen/Arc42-Node-MCP-Server.git
# Or after cloning:
npm run submodule:init
npm包用户注意事项:该子模块未包含在npm包中。当子模块不可用时,使用回退值。

🚀 快速开始

安装

# Install globally (installs latest version by default)
npm install -g @h2nguyen/arc42-node-mcp-server

# Or install a specific version
npm install -g @h2nguyen/arc42-node-mcp-server@
小贴士:检查 或 对于可用版本。

在Claude Desktop中设置

添加到您的Claude配置文件中:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • 视窗: %APPDATA%\Claude\claude_desktop_config.json

使用npx(无需安装):

{
  "mcpServers": {
    "arc42-mcp-server": {
      "command": "npx",
      "args": ["-y", "@h2nguyen/arc42-node-mcp-server", "/path/to/your/project"]
    }
  }
}

使用全局安装:

{
  "mcpServers": {
    "arc42-mcp-server": {
      "command": "arc42-mcp",
      "args": ["/path/to/your/project"]
    }
  }
}

在游标中设置

在Cursor中添加到MCP设置中:

使用npx(无需安装):

{
  "mcpServers": {
    "arc42-mcp-server": {
      "command": "npx",
      "args": ["-y", "@h2nguyen/arc42-node-mcp-server", "${workspaceFolder}"]
    }
  }
}

使用全局安装:

{
  "mcpServers": {
    "arc42-mcp-server": {
      "command": "arc42-mcp",
      "args": ["${workspaceFolder}"]
    }
  }
}

Cline中的设置

添加到Cline MCP设置文件(~/.cline/data/settings/cline_mcp_settings.json):

使用npx(无需安装):

{
  "mcpServers": {
    "arc42-mcp-server": {
      "disabled": false,
      "timeout": 60,
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@h2nguyen/arc42-node-mcp-server", "/path/to/your/project"],
      "autoApprove": [
        "arc42-workflow-guide",
        "arc42-init",
        "arc42-status",
        "update-section",
        "generate-template",
        "get-section"
      ]
    }
  }
}
⚠️ 对NVM用户很重要:对于使用NVM的npx方法,您可能需要使用npx的完整路径: /path/to/.nvm/versions/node/vXX.X.X/bin/npx

在NVM中使用npm包:

⚠️ 对NVM用户很重要:Cline在不加载shell配置文件的情况下生成MCP服务器(.zshrc/.bashrc),因此NVM管理的Node.js路径不在PATH中。您必须使用 完全绝对路径 Node.js二进制文件和 arc42-mcp 命令。看 故障排除:NVM用户 了解详情。
{
  "mcpServers": {
    "arc42-mcp-server": {
      "disabled": false,
      "timeout": 60,
      "type": "stdio",
      "command": "/path/to/.nvm/versions/node/vXX.X.X/bin/node",
      "args": [
        "/path/to/.nvm/versions/node/vXX.X.X/bin/arc42-mcp",
        "/path/to/your/project"
      ],
      "autoApprove": [
        "arc42-workflow-guide",
        "arc42-init",
        "arc42-status",
        "update-section",
        "generate-template",
        "get-section"
      ]
    }
  }
}

要查找NVM路径,请运行:

# Get the Node.js binary path
nvm which current
# Example output: /Users/yourname/.nvm/versions/node/v24.13.0/bin/node

# The arc42-mcp command is in the same bin directory
# /Users/yourname/.nvm/versions/node/v24.13.0/bin/arc42-mcp

使用不带NVM的npm包(system Node.js):

如果Node.js是在系统范围内安装的(不是通过NVM),您可以使用更简单的配置:

{
  "mcpServers": {
    "arc42-mcp-server": {
      "disabled": false,
      "timeout": 60,
      "type": "stdio",
      "command": "arc42-mcp",
      "args": ["/path/to/your/project"],
      "autoApprove": [
        "arc42-workflow-guide",
        "arc42-init",
        "arc42-status",
        "update-section",
        "generate-template",
        "get-section"
      ]
    }
  }
}

使用本地构建:

{
  "mcpServers": {
    "arc42-mcp-server": {
      "disabled": false,
      "timeout": 60,
      "type": "stdio",
      "command": "node",
      "args": [
        "/path/to/Arc42-Node-MCP-Server/dist/index.js",
        "/path/to/your/project"
      ],
      "autoApprove": [
        "arc42-workflow-guide",
        "arc42-init",
        "arc42-status",
        "update-section",
        "generate-template",
        "get-section"
      ]
    }
  }
}
备注:对于使用NVM的本地构建,使用Node.js二进制文件的完整路径作为 command 而不是仅仅 node.

故障排除:NVM用户

如果您看到“MCP错误-32001:请求超时”或服务器无法启动,这通常是由NVM路径问题引起的:

  1. 问题:Cline在不采购外壳轮廓的情况下生产流程,因此 nodearc42-mcp 命令解析为系统路径(或根本找不到),而不是NVM管理的版本。
  1. 解决方案:在配置中使用完整的绝对路径:

- command:Node.js二进制文件的完整路径(例如。, ~/.nvm/versions/node/v24.13.0/bin/node) - 第一 args item:完整路径 arc42-mcp (例如。, ~/.nvm/versions/node/v24.13.0/bin/arc42-mcp)

  1. 为什么是两条路?:即使您使用完整路径 arc42-mcp,剧本的shebang(#!/usr/bin/env node)将解决 node 来自PATH,这可能指向不兼容的系统Node.js版本。通过直接指定Node.js作为命令,我们完全绕过了shebang。

了解工作区配置

arc42 MCP服务器需要知道 在哪里创建和管理文档文件。有两种配置方式:

选项1:默认工作区路径(服务器启动参数)

启动MCP服务器时,您可以提供默认工作区路径作为命令行参数:

node dist/index.js /path/to/my-project

这组 /path/to/my-project 作为默认位置。服务器将在以下位置创建文档 /path/to/my-project/arc42-docs/.

在MCP配置中:

  • 克劳德桌面: "args": ["/path/to/your/project"]
  • 光标: "args": ["${workspaceFolder}"] (动态使用当前项目)
  • 克莱恩: "args": ["/path/to/dist/index.js", "/path/to/default/project"]

如果没有提供路径,服务器将使用当前工作目录(process.cwd()).

选项2:动态目标文件夹参数(每个工具覆盖)

每个工具调用都可以包含一个可选的 targetFolder 用于覆盖默认工作区的参数:

arc42-init {
  "projectName": "My Project",
  "targetFolder": "/Users/me/another-project"
}

这在以下情况下很有用:

  • 您希望在不重新配置服务器的情况下处理多个项目
  • 您正在使用Cline/其他AI助手,工作空间环境可能会有所不同
  • 您希望AI代理动态选择在哪里编写文档

优先级: targetFolder 参数(如果提供)>服务器启动参数>当前工作目录

推荐

用例建议
单个项目焦点在服务器参数中设置默认路径
多项目工作流程使用 targetFolder 动态参数
支持工作区的IDE使用 ${workspaceFolder} 变量
Cline/AI代理省略默认路径,使用 targetFolder

第一步

  1. 从指南开始:让你的AI助手运行 arc42-workflow-guide
  2. 初始化文档:使用 arc42-init 使用您的项目名称
  3. 检查状态:运行 arc42-status 查看您的进度
  4. 生成模板:使用 generate-template 对于特定部分
  5. 迭代文档:使用 update-section 添加内容

🛠️ 可用工具

arc42工作流程指南

加载完整的arc42文档工作流程指南,其中包含所有12个部分的说明。

arc42-workflow-guide {
  language?: "EN" | "DE" | "ES" | ...  // Optional: language code (default: EN)
  format?: "asciidoc" | "markdown"     // Optional: output format (default: asciidoc)
}

arc42初始化

为您的项目初始化arc42文档工作区。

arc42-init {
  projectName: "Your Project Name",
  language?: "EN",       // Optional: language for templates (default: EN)
  format?: "asciidoc",   // Optional: output format (default: asciidoc)
  force?: false,         // Re-initialize even if exists
  targetFolder?: "/path/to/project"  // Optional: specify target directory
}

arc42状态

检查文档的状态,包括完成百分比和章节详细信息。

arc42-status {
  targetFolder?: "/path/to/project"  // Optional: specify target directory
}
// Returns: language info, format info, available languages/formats, and localized section titles

生成模板

为12个arc42部分中的任何一个生成详细的模板。

generate-template {
  section: "01_introduction_and_goals" | "02_architecture_constraints" | ...,
  language?: "EN" | "DE" | "ES" | ...  // Optional: language code (default: EN)
  format?: "asciidoc" | "markdown"     // Optional: output format (default: asciidoc)
}

更新部分

更新特定arc42部分中的内容。

update-section {
  section: "01_introduction_and_goals",
  content: "= Your AsciiDoc or Markdown content here",
  mode?: "replace" | "append",
  targetFolder?: "/path/to/project"  // Optional: specify target directory
}
// Note: Automatically detects format from existing file extension

获取部分

阅读特定arc42部分的内容。

get-section {
  section: "01_introduction_and_goals",
  targetFolder?: "/path/to/project"  // Optional: specify target directory
}
// Note: Supports both .md and .adoc file formats

🌍 多语言支持

此MCP服务器支持以下文档模板 11种语言,与官方的arc42模板翻译相匹配。

支持的语言

代码语言母语
EN英语英语
DE德语德语
ES西班牙语西班牙语
FR法语法语
IT意大利语意大利语
NL荷兰语荷兰语
PT葡萄牙语
RU俄语Руский
捷克语捷克语
UKR乌克兰语
ZHChinese中文

使用语言

使用特定语言初始化:

arc42-init {
  projectName: "Mein Projekt",
  language: "DE"  // German templates and section titles
}

生成特定语言的模板:

generate-template {
  section: "01_introduction_and_goals",
  language: "FR"  // French template
}

获取特定语言的工作流程指南:

arc42-workflow-guide {
  language: "ES"  // Spanish guide
}

语言配置

语言存储在 config.yaml 初始化工作区时:

projectName: My Project
language: DE
format: asciidoc
  • arc42-status 读取并显示配置的语言
  • 模板和节标题基于此设置进行本地化
  • 语言代码不区分大小写(de, DE, De 所有工作)

📄 多格式支持

此MCP服务器支持以下文档输出 2种格式:Markdown和AsciiDoc。

支持格式

代码格式扩展名别名
asciidocAsciiDoc.adoc美国儿科学会会员、美国儿科学会医生、美国儿科协会会员
markdownMarkdown.mdmd、mdown、mkd
默认:AsciiDoc是新项目的默认格式。AsciiDoc提供了更丰富的格式功能(包括、警告、交叉引用),非常适合专业文档。

使用格式

使用特定格式初始化:

arc42-init {
  projectName: "My Project",
  format: "markdown"  // Use Markdown instead of default AsciiDoc
}

以特定格式生成模板:

generate-template {
  section: "01_introduction_and_goals",
  format: "asciidoc"  // AsciiDoc template
}

获取特定格式的工作流程指南:

arc42-workflow-guide {
  format: "markdown"  // Markdown guide
}

结合语言和格式:

arc42-init {
  projectName: "Mein Projekt",
  language: "DE",
  format: "asciidoc"  // German AsciiDoc templates
}

格式配置

格式存储在 config.yaml 初始化工作区时:

projectName: My Project
language: EN
format: asciidoc
  • arc42-status 读取并显示配置的格式
  • update-section 从扩展名自动检测文件格式
  • get-section 支持两者 .md.adoc 文件
  • 格式代码不区分大小写,并支持别名(adoc, ASCIIDOC, md 所有工作)

📚 12弧42节

  1. 引言与目标 -要求、质量目标、利益相关者
  2. 架构约束 -技术和组织限制
  3. 背景和范围 -商业和技术背景
  4. 解决方案策略 -基本决策和战略
  5. 构建块视图 -系统的静态分解
  6. 运行时视图 -动态行为和场景
  7. 部署视图 -基础设施和部署
  8. 跨领域概念 -总体规定和方法
  9. 架构决策 -重要决策(ADR)
  10. 质量要求 -质量树和场景
  11. 风险和技术债务 -已知问题和风险
  12. 词汇表 -重要条款

📖 用法示例

示例1:重新开始

You: "Help me create architecture documentation for my e-commerce platform"

AI runs: arc42-workflow-guide
AI runs: arc42-init { projectName: "E-Commerce Platform" }
AI runs: generate-template { section: "01_introduction_and_goals" }

AI: "Let's start with Section 1. What are your top 3 quality goals?"

示例2:文档特定部分

You: "Document the deployment architecture - we use AWS with ECS"

AI runs: generate-template { section: "07_deployment_view" }
AI creates content with your AWS/ECS details
AI runs: update-section { 
  section: "07_deployment_view",
  content: "..." 
}
AI runs: arc42-status

示例3:添加架构决策

You: "Document why we chose PostgreSQL over MongoDB"

AI runs: generate-template { section: "09_architecture_decisions" }
AI creates ADR with context, decision, and consequences
AI runs: update-section { 
  section: "09_architecture_decisions",
  content: "...",
  mode: "append"
}

🏗️ 项目结构

初始化后,您的项目将具有:

your-project/
└── arc42-docs/
    ├── README.md                    # Getting started guide
    ├── arc42-documentation.md        # Main combined document
    ├── config.yaml                  # Configuration
    ├── images/                      # Diagrams and images
    └── sections/                    # Individual section files
        ├── 01_introduction_and_goals.md
        ├── 02_architecture_constraints.md
        ├── 03_context_and_scope.md
        ├── 04_solution_strategy.md
        ├── 05_building_block_view.md
        ├── 06_runtime_view.md
        ├── 07_deployment_view.md
        ├── 08_concepts.md
        ├── 09_architecture_decisions.md
        ├── 10_quality_requirements.md
        ├── 11_technical_risks.md
        └── 12_glossary.md

🎯 最佳实践

AI助理

  1. 始终从指南开始:运行 arc42-workflow-guide 了解结构
  2. 定期检查状态:使用 arc42-status 跟踪进度
  3. 一次一个部分:在进入下一节之前,集中精力完成一节
  4. 使用图表:在内容中生成Mermaid/PlantUML图
  5. 提出澄清性问题:不要想当然——向用户询问具体细节

对于用户

  1. 从第1节开始:始终从介绍和目标开始
  2. 迭代式:您不需要立即完成所有部分
  3. 专注于决策:记录为什么,而不仅仅是什么
  4. 保持最新状态:随着架构的发展而更新
  5. 使用版本控制:将arc42文档目录提交到Git

🧠 Arc42的克劳德技能

该项目包括一个预制 克劳德技能 教克劳德(通过 克劳德代码 或任何有技能意识的Claude集成)如何有效地使用arc42 MCP服务器工具进行架构文档,而无需手动提示。

Arc42技能是什么?

该技能是一个结构化的知识包,位于 .claude/skills/arc42-docs-mcp/ 包含:

.claude/skills/arc42-docs-mcp/
├── SKILL.md              # Skill definition with workflows, tool reference, and behavioral guidelines
└── references/
    ├── setup.md          # MCP server installation and configuration for all clients
    └── examples.md       # Practical usage examples (8 scenarios)

当出现在项目中时,Claude会自动加载技能并理解:

  • 正确 工作流顺序 arc42文档(指南→ init → 状态→ 模板→ 写→ 审查)
  • 所有6个MCP工具、其参数和预期响应
  • 最佳实践 例如,在编写之前始终生成模板,对ADR使用附加模式,并在假设项目细节之前提出澄清问题
  • 推荐的文件顺序 (第1节→ 3 → 4 → 5 → 9,然后填写其余部分)

在其他项目中安装该技能

要在使用Claude Code的任何项目中启用arc42技能:

选项1:复制技能目录

# From your project root
mkdir -p .claude/skills
cp -r /path/to/Arc42-Node-MCP-Server/.claude/skills/arc42-docs-mcp .claude/skills/

选项2:Symlink(保持技能更新)

# From your project root
mkdir -p .claude/skills
ln -s /path/to/Arc42-Node-MCP-Server/.claude/skills/arc42-docs-mcp .claude/skills/arc42-docs-mcp
先决条件:还必须在项目的MCP设置中配置arc42 MCP服务器(.mcp.json克劳德桌面配置等)。这项技能教会了克劳德 *怎么* 使用这些工具,但MCP服务器必须正在运行才能提供这些工具。看 在Claude Desktop中设置, 在游标中设置,或 Cline中的设置 用于服务器配置。

安装后,提交 .claude/skills/arc42-docs-mcp/ 目录到版本控制,这样所有团队成员都能自动从技能中受益。

技能触发器

克劳德在对话中检测到以下任何一种情况时激活arc42技能:

触发器示例
架构文档关键字“创建架构文档”、“记录架构”、“更新架构文档”
Arc42引用“Arc42”、“初始化Arc42”和“Arc42模板”
节特定请求“记录部署视图”、“添加质量要求”、“描述构建块”
ADR提到“添加架构决策记录”,“记录我们为什么选择PostgreSQL”
12个arc42部分中的任何一个介绍和目标、约束、背景和范围、解决方案策略等。

为您的项目带来的好处

优势无技能有技能
工作流知识必须手动提示Claude遵循arc42顺序Claude自动遵循指南→ init → 模板→ 编写工作流
工具使用可能会错误调用工具或跳过步骤以正确的顺序调用具有正确参数的正确工具
内容质量通用文档输出首先生成模板,提出澄清问题,记录为什么而不仅仅是什么
ADR处理覆盖现有决策的风险始终首先读取现有ADR并使用附加模式
格式意识可能混合AsciiDoc和Markdown语法检查 arc42-status 用于配置格式和一致写入
多语言默认为仅英语在所有工具调用中尊重配置的语言
团队一致性每个开发人员都会得到不同的结果版本控制方面的共同技能确保了一致的文档质量

🔧 发展

开发方法论

该项目是使用 规范驱动开发(SDD),一种强调在实施之前创建详细规范的方法。在编写任何代码之前,通过结构化的工作流对功能进行规划、记录和批准。

SDD工作流程由以下驱动 @pimzino/spec工作流mcp,MCP服务器,提供:

  • 结构化规范工作流程(要求→ 设计→ 任务→ 实施)
  • 用于跟踪进度的实时web仪表板
  • 开发阶段之间的审批门
  • 知识保存实施日志

文件质量保证

架构文档通过以下方式进行审查和验证 达利,一个Documentation Access CLI,将LLM与文档项目连接起来。作为MCP服务器,dacli支持:

  • 文档的分层导航和内容检索
  • 在所有文档部分进行全文搜索
  • 结构验证以检测孤立文件和问题
  • AsciiDoc/MaMarkdown内容的程序化查询和操作

从源头构建

git clone https://github.com/h2nguyen/Arc42-Node-MCP-Server.git
cd Arc42-Node-MCP-Server
npm install
npm run build

以开发模式运行

npm run dev /path/to/your/project

🧪 测试

该项目通过使用全面的测试套件来保持高质量的标准 维测试.

运行测试

# Run all tests
npm test

# Run tests with coverage
npm run test:coverage

# Run tests in watch mode
npm run test:watch

测试结构

src/__tests__/
├── fixtures/
│   └── test-helpers.ts     # Shared test utilities and constants
├── templates/
│   └── index.test.ts       # Tests for all twelve arc42 templates
├── tools/
│   └── arc42-init.test.ts  # Tests for the arc42-init tool
└── types.test.ts           # Tests for types and constants

覆盖阈值

该项目强制实施最低覆盖阈值以保持质量:

度量阈值
报表70%
分支机构60%
功能70%
线路70%

测试类别

  • 单元测试:核心函数、类型助手和常量
  • 模板测试:结构和指导内容的所有十二个arc42部分模板
  • 工具测试:MCP工具定义和执行行为
  • 错误处理:无效输入、边缘情况和优雅失败

CI/CD管道

GitHub Actions工作流在拉取请求和推送时自动运行:

  • 棉绒:TypeScript类型检查和ESLint
  • 测试:带覆盖率报告的多版本Node.js矩阵(22,24)
  • 码头工人:容器构建验证
  • 安全:用于漏洞扫描的npm审计

🐳 Docker支持

构建Docker镜像

docker build -t arc42-node-mcp-server .

使用Docker运行

# Run with a mounted project directory
docker run -v /path/to/project:/project arc42-node-mcp-server

# Interactive mode
docker run -it -v /path/to/project:/project arc42-node-mcp-server

使用Docker Compose

Docker Compose为开发和测试提供了方便的设置:

# Build the container
docker compose build

# Run the MCP server
docker compose run --rm arc42-node-mcp-server

# Run in development mode with live reload
docker compose up dev

使用MCP Inspector进行独立测试(推荐)

MCP检查员 提供了一个基于web的用户界面,用于测试MCP服务器。

📖 详细指南:参见 docs/mcp-inspector-testing.md 获取完整的分步说明。

npx快速入门(推荐):

# Build the project
npm run build

# Start MCP Inspector with the arc42 server
npx @modelcontextprotocol/inspector node dist/index.js ./test-project

然后打开 http://localhost:6274 在您的浏览器中。

使用Docker Compose:

# Prerequisites: Build the project first
npm run build

# Create a test directory
mkdir -p test-project

# Start MCP Inspector with the arc42 server
docker compose up mcp-inspector

然后打开 http://localhost:6274 在您的浏览器中。服务器应该 自动连接,您将在“工具”选项卡中看到六个arc42工具,请参阅以下屏幕截图:

MCP-Inspector-Screenshot.png

备注:如果自动连接不起作用,请使用手动配置 容器路径: - 命令: node - 论据: /app/dist/index.js /project ⚠️ 不要使用像这样的本地路径 /Users/yourname/... -这些在Docker容器中不存在。

手动配置MCP检查器(独立):

如果独立运行MCP Inspector(不通过Docker),请使用您的 局部绝对路径:

字段
运输类型STDIO
指挥部node
论点/full/path/to/dist/index.js /full/path/to/test-project

点击 连接 开始测试工具。

检查员允许您:

  • 浏览可用工具(arc42-workflow-guide, arc42-init, arc42-status等等)
  • 使用自定义参数执行工具
  • 检查请求/响应有效载荷
  • 测试完整的MCP协议交互

Docker编写服务

服务描述用法
arc42-node-mcp-server生产就绪容器docker compose run --rm arc42-node-mcp-server
mcp-inspector带stdio传输的MCP检查员docker compose up mcp-inspector → http://localhost:6274
dev实时重载开发模式docker compose up dev

测试工作流程

# 1. Create a test project directory
mkdir -p test-project

# 2. Build the project
npm run build

# 3. Start MCP Inspector
docker compose up mcp-inspector

# 4. Open browser at http://localhost:6274

# 5. Test tools:
#    - Call arc42-workflow-guide (no params)
#    - Call arc42-init with {"projectName": "Test Project"}
#    - Call arc42-status (no params)
#    - Call generate-template with {"section": "01_introduction_and_goals"}

🤝 贡献

我们欢迎捐款!该项目满足了全球的架构文档需求。

  1. 分叉存储库
  2. 创建功能分支(git checkout -b feature/amazing-feature)
  3. 提交您的更改(git commit -m 'Add amazing feature')
  4. 推到分支(git push origin feature/amazing-feature)
  5. 打开拉取请求

贡献.md 详细指南。

📄 许可证

此项目根据Apache许可证2.0获得许可——请参阅 许可证 文件以获取详细信息。

  • 有关软件代码属性,请参见 通知.
  • 有关完整的arc42许可条款,请参阅 执照ARC42.

🙏 致谢

  • arc42 -经过验证、实用和务实的架构模板
  • @pimzino/spec工作流mcp -MCP服务器为我们的规范驱动开发工作流程提供动力
  • 达利 -Documentation Access CLI用于查看和验证体系结构文档

📞 支持

  • 问题:

🔗 链接

  • arc42网站: https://arc42.org/
  • arc42文件: https://docs.arc42.org/
  • arc42 GitHub: https://github.com/arc42
  • arc42示例: https://arc42.org/examples(其他示例嵌入在以下文档中https://docs.arc42.org/)
  • arc42常见问题: https://faq.arc42.org/
  • Github上的arc42节点MCP服务器: https://github.com/h2nguyen/Arc42-Node-MCP-Server
  • NPM上的arc42节点MCP服务器: https://www.npmjs.com/package/@h2nguyen/arc42节点mcp服务器/v/最新
  • MCP规范: https://modelcontextprotocol.io/specification/

______________________________________________________________________

建于❤️ 面向全球软件架构社区

![arc42](https://arc42.org/) ![MCP](https://modelcontextprotocol.io/)

⭐ 星史

![Star History Chart](https://www.star-history.com/#h2nguyen/Arc42-Node-MCP-Server&type=date&legend=top-left)

目录标签

目录标签

开发工具TypeScriptClaude文档生成架构文档本地部署AI辅助多语言支持

支持客户端

Claude DesktopClaudeCursorCline

接入字段

传输方式(transport,传输协议)

stdio

鉴权方式(authType,认证方式)

none

运行时(runtime,运行环境)

Docker

工具数量(toolCount,工具数)

6

资源数量(resourceCount,资源数)

0

提示词数量(promptCount,提示词数)

0

权限和风险

stdionone部署方式未说明

接入前请确认传输方式、认证方式和部署位置,并根据实际工具能力限制访问范围。

安装前确认

不要直接授予不必要的文件、网络或账号权限;先核对安装命令和配置内容。

来源信息

继续浏览同类 MCP