Homebridge MCP服务

Homebridge MCP Server是一个实验性的MCP服务器,用于与Homebridge安装进行交互,支持本地开发和Docker部署。

  • by lucaspbastos
  • Shell
  • 本地部署
  • 更新于
在 GitHub 查看 lucaspbastos/homebridge-mcp-server

使用说明

Homebridge MCP 服务器

用于与Homebridge安装对接的实验性MCP服务器。

先决条件

  • Node.js 24.x(在(某处)指定) .nvmrc)
  • npm(随 Node.js 一起提供)

安装

安装 Node.js

使用 nvm(推荐):

nvm install
nvm use

或者从(官方/指定源)手动安装 Node.js 24.x nodejs.org(中文可表述为“Node.js官方网站”)。

安装依赖项

npm install

发展

构建

将TypeScript编译为 build/ 目录:

npm run build

跑

运行构建的服务器:

npm start

手表模式

文件更改时自动重建:

npm run dev

Linting(代码检查)

运行 ESLint 检查:

npm run lint

测试

运行测试套件:

npm test

Docker

构建Docker镜像

本地测试:

./scripts/test-docker-build.sh

这构建了一个标记为(指定名称)的 Docker 镜像 homebridge-mcp-server:local.

运行 Docker 容器

docker run --rm homebridge-mcp-server:local

本地测试脚本

这个(或:该) scripts/ 该目录包含用于在本地测试CI/CD工作流的实用工具:

  • test-ci.sh - 模拟CI质量检查(代码规范检查 + 测试 + 构建)
  • test-docker-build.sh - 在本地构建Docker镜像
  • test-publish.sh - 模拟版本升级的发布工作流程

见 scripts/README.md 以获取详细的使用说明。

作为命令行界面(CLI)工具的安装

一旦发布到npm,即可全局安装:

npm install -g homebridge-mcp-server

或者直接使用 npx 运行:

npx homebridge-mcp-server

CI/CD 工作流

持续集成

在特性分支和拉取请求上运行:

  • 质量检查(代码审查+测试)
  • 构建验证
  • 通过自动化方式 .github/workflows/ci.yaml

发布工作流程

手动或标签触发的发布:

  • 版本计算与包更新
  • 在获得批准后发布到npm
  • 构建并发布Docker镜像到GHCR(GitHub Container Registry)和Docker Hub(需获得批准)
  • 创建GitHub发布版本
  • 通过自动化实现 .github/workflows/release.yaml

项目结构

.
├── src/                  # TypeScript source files
├── build/                # Compiled JavaScript (git-ignored)
├── scripts/              # Local testing utilities
├── .github/workflows/    # CI/CD workflows
├── containers/           # Docker development environment
└── Dockerfile            # Multi-stage Alpine build

许可证

ISC(Internet Service Center,互联网服务中心)