项目简介

Shadowdog是一个基于Node.js的构件生成工具,能够监控文件变化并自动生成构件。其MCP服务器插件提供了标准化的接口,使AI客户端能够:

  • 暂停/恢复构件生成
  • 查询所有构件状态
  • 按需生成特定构件
  • 获取系统状态信息

主要功能

  • 文件监控:自动检测项目文件变化并触发构件生成
  • 智能缓存:通过文件内容、路径、环境变量等计算缓存标识
  • 插件系统:支持多种插件扩展功能
  • MCP集成:通过HTTP服务器提供标准MCP协议接口
  • 构件管理:提供完整的构件状态查询和按需生成能力
  • 任务管理:支持暂停和恢复构件生成,防止在代码更改期间产生冲突

安装步骤

  1. 安装Shadowdog包:
npm install shadowdog --save-dev
  1. 在配置文件中启用MCP插件:
{
  "plugins": [
    {
      "name": "shadowdog-mcp"
    }
  ]
}
  1. 启动watch模式(自动启动MCP服务器):
npx shadowdog --watch

服务器配置

在MCP客户端(如Cursor)的配置中添加:

{
  "mcpServers": {
    "shadowdog": {
      "url": "http://localhost:8473/mcp"
    }
  ]
}

环境变量配置

  • 'SHADOWDOG_MCP_PORT':设置MCP服务器端口(默认8473)
  • 'SHADOWDOG_MCP_HOST':设置服务器主机(默认localhost)

基本使用方法

  1. 配置好shadowdog.json文件,定义需要监控的文件和生成构件的命令
  2. 运行'npx shadowdog --watch'启动服务
  3. 在AI工具中配置MCP服务器连接信息
  4. 使用MCP工具:
    • 'pause-shadowdog':暂停构件生成
    • 'resume-shadowdog':恢复构件生成
  • 'get-artifacts':查询所有构件信息
  • 'compute-artifact':生成特定构件
  • 'get-shadowdog-status':查看系统状态

可用MCP工具

  • 暂停构件生成:防止在代码更改期间自动生成构件
  • 查询构件状态:获取每个构件的生成状态、最后更新时间等
  • 支持并发操作处理,能够正确管理待处理任务

信息

分类

开发者工具