🍓 Pi-hole MCP 服务器

一个用于 Pi-hole 的 Model Context Protocol (MCP) 服务器。此服务器将 Pi-hole 功能作为工具公开，这些工具可以由 AI 助手使用。

依赖项

Docker

• Docker 安装指南

uv（可选，用于开发）

如果你想在本地运行应用程序，请使用 uv。通过你的包管理器安装它。

环境

在项目根目录中创建一个 .env 文件，其中包含你的 Pi-hole 凭据：

# 主 Pi-hole（必需）
PIHOLE_URL=https://your-pihole.local/
PIHOLE_PASSWORD=your-admin-password
#PIHOLE_NAME=Primary        # 可选，默认为 URL 如果未设置

# 次要 Pi-hole（可选）
#PIHOLE2_URL=https://secondary-pihole.local/
#PIHOLE2_PASSWORD=password2
#PIHOLE2_NAME=Secondary     # 可选

# 最多 4 个 Pi-hole：
#PIHOLE3_URL=...
#PIHOLE3_PASSWORD=...
#PIHOLE3_NAME=...

#PIHOLE4_URL=...
#PIHOLE4_PASSWORD=...
#PIHOLE4_NAME=...

项目结构

• src/：包含项目的源代码文件。
• public/：包含构建后的静态资源，如 HTML、CSS 和 JavaScript 文件。

如何运行服务器

使用 Docker 运行

1. 确保你已经安装了 Docker 并且正在运行。
2. 在项目根目录中创建一个 .env 文件，配置你的 Pi-hole 凭据。
3. 执行以下命令来构建并运行容器：

docker-compose up --build

使用 Node.js 运行

1. 确保你已经安装了 Node.js 和 npm。
2. 安装项目依赖：

npm install

3. 启动服务器：

npm start

API 文档

资源

• /api/pi-holes：获取所有 Pi-hole 的信息。
  • 方法：GET
  • 响应：包含所有 Pi-hole 的详细信息，包括 URL 和状态。

工具

• /api/tools：获取所有可用工具的列表。
  • 方法：GET
  • 响应：包含工具的名称和描述。

示例

获取所有 Pi-hole 的信息

curl http://localhost:3000/api/pi-holes

调用工具

调用一个名为 check-dns-records 的工具：

curl -X POST http://localhost:3000/api/tools/check-dns-records \
  -H "Content-Type: application/json" \
  -d '{"piHoleUrl": "https://your-pihole.local/"}'

许可证

MIT