使用说明

Kiro Living Docs 是一个智能文档生成器，作为一个MCP服务器运行，能够实时分析项目代码，自动生成、维护和更新项目文档。它支持多种编程语言，并提供一个美观的Web UI来展示交互式文档。

主要功能点

实时文档更新: 代码更改后5秒内自动更新文档。
零配置: 智能项目检测，开箱即用。
多语言支持: 支持TypeScript、JavaScript、Python和Go等多种语言的代码分析。
现代化Web UI: 提供具有搜索和导航功能的响应式Web界面，展示生成的文档。
Kiro集成: 充分利用Kiro IDE的转向文件（steering files）、钩子（hooks）和上下文感知能力。
丰富的MCP工具: 提供'generate_docs'（生成文档）、'watch_project'（实时监控）、'stop_watching'（停止监控）、'detect_project'（项目检测）等工具，供MCP客户端调用。

安装步骤

前提条件:
- Node.js 18.0.0 或更高版本
- 支持MCP的Kiro IDE (或兼容的MCP客户端)

设置:

克隆并构建项目：

git clone https://github.com/sgharlow/kiro-living-docs-devpost.git
cd kiro-living-docs-devpost
npm install
npm run build

服务器配置 (MCP客户端使用)

MCP客户端需要配置Living Documentation Generator服务器的启动命令。以下是一个示例配置，您需要将其添加到您的MCP客户端配置中（例如 '~/.kiro/settings/mcp.json'），以便您的客户端能够连接到此服务器：

{
  "mcpServers": {
    "living-docs": {
      "command": "node",
      "args": ["/absolute/path/to/kiro-living-docs-devpost/dist/server.js"],
      "cwd": "/absolute/path/to/kiro-living-docs-devpost",
      "description": "智能实时文档生成器",
      "capabilities": {
        "tools": [
          {
            "name": "generate_docs",
            "description": "生成项目文档"
          },
          {
            "name": "watch_project",
            "description": "开始实时监控项目文件变化，并自动更新文档"
          },
          {
            "name": "stop_watching",
            "description": "停止监控项目文件变化"
          },
          {
            "name": "detect_project",
            "description": "自动检测项目类型、语言和框架，并可选择生成配置"
          },
          {
            "name": "start_onboarding",
            "description": "启动新用户交互式引导流程"
          },
          {
            "name": "configuration_wizard",
            "description": "启动交互式配置向导以进行复杂的项目设置"
          },
          {
            "name": "troubleshoot",
            "description": "诊断问题并获取故障排除建议"
          },
          {
            "name": "get_analytics",
            "description": "获取使用分析和性能洞察"
          }
        ]
      }
    }
  }
}

重要提示: 请将 '/absolute/path/to/kiro-living-docs-devpost' 替换为您实际克隆此仓库的绝对路径。
配置后: 重启您的MCP客户端（例如Kiro IDE）以加载Living Documentation Generator服务器。

基本使用方法

生成文档: 在MCP客户端中调用 'generate_docs' 工具，并提供项目路径和输出格式等参数。例如，生成Markdown格式的文档： 'generate_docs --projectPath /path/to/your/project --outputFormat markdown'
实时监控: 调用 'watch_project' 工具，服务器将开始监控您项目的代码更改并自动更新文档。 'watch_project --projectPath /path/to/your/project'
停止监控: 调用 'stop_watching' 工具即可停止文档的实时更新。 'stop_watching'

关键词

使用说明

主要功能点

安装步骤

服务器配置 (MCP客户端使用)

基本使用方法

信息