ImmyBot

io.github.WYRE-AI由 GitHub 账号 WYRE-AI 发布v2.0.0更新于 Nov 21, 2026

MCP server for ImmyBot — Windows software deployment, maintenance, tenants, deployments.

概览

AI 生成的概览

把助手接入 ImmyBot,用于 Windows 终端管理:列出计算机、暂存软件安装、运行维护会话并查看任务。

可以做什么
  • 列出、搜索、查看和创建计算机,查看硬件软件清单与部署记录,并强制代理签入
  • 浏览、搜索和查看软件包、版本、分类与发布者,并暂存安装
  • 启动并查询维护会话,把期望状态同步到设备
  • 管理租户、PowerShell 脚本和后台任务
  • 查看服务器状态与工具分组
适用场景
适合在 ImmyBot 中管理 Windows 终端的 MSP 或 IT 管理员,希望助手在不打开网页控制台的情况下查询设备、规划软件推送,或触发并跟踪维护会话。
运行要求
以本地进程(npm 包或容器镜像)通过 stdio 运行,或作为 HTTP 服务供网关托管。直连模式需要来自 Microsoft Entra ID 应用注册的 IMMYBOT_INSTANCE_SUBDOMAIN、IMMYBOT_TENANT_ID、IMMYBOT_CLIENT_ID 和 IMMYBOT_CLIENT_SECRET,且该应用需具备 ImmyBot API 权限。HTTP 模式还需 CONDUIT_S2S_SECRET 与 X-Gateway-S2S 签名;网关模式要求每次请求携带四个 X-ImmyBot-* 请求头。
安装前请注意
需要具备 ImmyBot API 权限的 Entra ID 客户端密钥(IMMYBOT_CLIENT_SECRET),应尽量缩小应用权限范围。工具会写入生产终端:创建计算机、暂存软件安装和启动维护会话都会改变设备状态,安装需由维护会话同步后才真正生效。HTTP 模式必须使用真实的 CONDUIT_S2S_SECRET;不安全的开发绕过会关闭请求头校验,只能绑定回环地址。

安装

在 SourceWeft 中

  1. 打开 控制台中的 ImmyBot,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

@wyre-ai/immybot-mcp

MCP server for ImmyBot - Windows endpoint management and software deployment automation.

Features

  • 🔐 OAuth 2.0 Authentication - Microsoft Entra ID client credentials
  • 🏢 Multi-tenant Support - Per-instance subdomain configuration
  • 🧭 Flat Tool List - Every tool is listed and callable immediately
  • 💻 Comprehensive Coverage - Computers, software, deployments, scripts, tenants, maintenance sessions, tasks
  • ⚡ Gateway Ready - Stateless per-request operation for WYRE MCP Gateway
  • 🚀 Docker Deployment - Container-ready with health checks
  • 📊 Structured Logging - Detailed operation tracking

Quick Start

Docker (Recommended)

The image listens on 0.0.0.0 inside the container and defaults to AUTH_MODE=gateway. Publish the port on loopback and pass a real CONDUIT_S2S_SECRET. In gateway mode, ImmyBot credentials arrive on each request as headers; they are not read from the environment.

bash
docker run -d \  --name immybot-mcp \  -p 127.0.0.1:8080:8080 \  -e CONDUIT_S2S_SECRET \  -e AUTH_MODE=gateway \  -e MCP_TRANSPORT=http \  -e MCP_HTTP_PORT=8080 \  -e LOG_LEVEL=info \  ghcr.io/wyre-ai/immybot-mcp:latest

Compose refuses to start when CONDUIT_S2S_SECRET is unset. The gateway service does not set IMMYBOT_* variables or env_file, so a project .env cannot inject static vendor credentials. It publishes 127.0.0.1:8080:8080:

bash
# openssl rand -hex 32 — do not use a placeholder such as changemeCONDUIT_S2S_SECRET="$(openssl rand -hex 32)" docker compose up

Direct Installation

bash
npm install @wyre-ai/immybot-mcpnpx @wyre-ai/immybot-mcp

Tools

Every tool is listed by tools/list and callable immediately. There is no domain to enter first. The domains below are documentation groupings only.

Upgrading from 1.x? immybot_navigate and immybot_back are gone. Call the domain tools directly, for example immybot_computers_list. immybot_status still works and now lists the tool groups.

Available Domains

  • computers - Device and endpoint management
  • software - Application and package management
  • deployments - Software deployment configuration
  • scripts - PowerShell script execution and management
  • tenants - Client organization management
  • maintenance_sessions - Device maintenance and state reconciliation
  • tasks - Background operation monitoring

Authentication

ImmyBot uses OAuth 2.0 with Microsoft Entra ID:

Required Configuration

FieldDescriptionExample
instanceSubdomainImmyBot instance subdomainacmemsp
tenantIdMicrosoft Entra tenant ID12345678-1234-1234-1234-123456789abc
clientIdApplication (client) ID87654321-4321-4321-4321-cba987654321
clientSecretClient secret valueyour-client-secret

Setup Steps

  1. Register Enterprise Application in Microsoft Entra ID
  2. Grant ImmyBot API permissions to the application
  3. Create client secret for the application
  4. Configure application in ImmyBot settings

OAuth scope: api://{client_id}/.default

Usage Examples

1. Computers

javascript
// List computersawait callTool('immybot_computers_list', {   tenantId: 1,  isOnline: true });
// Get computer detailsawait callTool('immybot_computers_get', { computerId: 123 });

2. Software Management

javascript
// Search for softwareawait callTool('immybot_software_search', { query: 'Chrome' });
// Install software (stages for maintenance session)await callTool('immybot_software_install', {  softwareId: 456,  computerIds: [123, 124, 125],  autoUpdate: true});

3. Maintenance Sessions

javascript
// Start maintenance session (reconciles deployments)await callTool('immybot_maintenance_sessions_start', {  computerId: 123,  sessionType: 'Manual'});
// Check session statusawait callTool('immybot_maintenance_sessions_get', { sessionId: 789 });

Two-Step Deployment Model

⚠️ Important: ImmyBot uses a two-step deployment workflow:

  1. Configure desired state - Software installations create deployments
  2. Reconcile via maintenance session - Sessions apply the desired state
javascript
// Step 1: Stage software installationawait callTool('immybot_software_install', {  softwareId: 123,  computerIds: [456]});// ↑ This creates a deployment, does NOT install immediately
// Step 2: Reconcile stateawait callTool('immybot_maintenance_sessions_start', {  computerId: 456});// ↑ This runs the maintenance session to actually install software

Environment Variables

Copy .env.example and set the variables below.

Gateway Mode (Docker)

VariableDefaultDescription
AUTH_MODEdirectSet to gateway for WYRE MCP Gateway. Gateway mode requires the four x-immybot-* credential headers on each /mcp request and never falls back to IMMYBOT_*. The Docker image and Compose default to gateway.
MCP_TRANSPORTstdioTransport mode (http or stdio)
MCP_HTTP_PORT8080HTTP server port
MCP_HTTP_HOST0.0.0.0 when a real CONDUIT_S2S_SECRET is set and this is unset; 127.0.0.1 for the insecure-dev bypassBind address. A configured secret honors this value, including 0.0.0.0, so container deploys stay reachable. The image and Compose set 0.0.0.0.
CONDUIT_S2S_SECRET—Required for HTTP. HMAC secret checked against X-Gateway-S2S on /mcp. Generate with openssl rand -hex 32. If empty or a known placeholder, the HTTP server logs an error and exits non-zero. The value is never logged.
MCP_ALLOW_INSECURE_DEVunsetSet to exactly 1 to start HTTP without CONDUIT_S2S_SECRET. Logs a warning, does not enforce X-Gateway-S2S, and binds 127.0.0.1 only. A non-loopback MCP_HTTP_HOST refuses to start. A placeholder secret still refuses to start. Local development only.
LOG_LEVELinfoLogging level (debug, info, warn, error)

/health stays unauthenticated and does not read credentials. The stdio transport does not use CONDUIT_S2S_SECRET.

Direct Mode (CLI)

VariableRequiredDescription
IMMYBOT_INSTANCE_SUBDOMAIN✅ImmyBot instance subdomain
IMMYBOT_TENANT_ID✅Microsoft Entra tenant ID
IMMYBOT_CLIENT_ID✅Application client ID
IMMYBOT_CLIENT_SECRET✅Client secret

HTTP authentication

With MCP_TRANSPORT=http and CONDUIT_S2S_SECRET set, every /mcp request must include X-Gateway-S2S. The check is verifyS2sHeader in src/s2s-verify.ts: the header value is t=<unix seconds>,v1=<hex>, where the hex is HMAC-SHA256 of the literal string t=<unix seconds> keyed with CONDUIT_S2S_SECRET (64 lowercase hex characters). The timestamp must be within 300 seconds of the server clock. A missing or invalid header is HTTP 401, before vendor credentials are read.

bash
TS=$(date +%s)SIG=$(printf 't=%s' "$TS" | openssl dgst -sha256 -hmac "$CONDUIT_S2S_SECRET" -hex | awk '{print $NF}')curl -sS http://127.0.0.1:8080/mcp \  -H 'Content-Type: application/json' \  -H 'Accept: application/json, text/event-stream' \  -H "X-Gateway-S2S: t=${TS},v1=${SIG}" \  -H 'X-ImmyBot-Instance-Subdomain: acmemsp' \  -H 'X-ImmyBot-Tenant-Id: 12345678-1234-1234-1234-123456789abc' \  -H 'X-ImmyBot-Client-Id: 87654321-4321-4321-4321-cba987654321' \  -H 'X-ImmyBot-Client-Secret: your-client-secret' \  -d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'

In AUTH_MODE=gateway, those four X-ImmyBot-* headers are required. A request missing any of them gets HTTP 401 and does not fall back to IMMYBOT_* in the process environment. Direct mode (AUTH_MODE unset) still requires a valid X-Gateway-S2S header, then uses the IMMYBOT_* environment variables. Direct mode does not read the X-ImmyBot-* headers.

Local HTTP without a secret is development-only. It binds 127.0.0.1 and logs a warning. A non-loopback MCP_HTTP_HOST (including the image default 0.0.0.0) makes startup exit. Do not publish that port off loopback.

bash
MCP_TRANSPORT=http MCP_ALLOW_INSECURE_DEV=1 npm start

Tools Reference

Status Tool

ToolDescription
immybot_statusShow the tool groups

Computers Tools

ToolDescription
immybot_computers_listList computers with filtering
immybot_computers_getGet computer details
immybot_computers_searchSearch computers by name
immybot_computers_inventoryGet hardware/software inventory
immybot_computers_createCreate computer record
immybot_computers_deploymentsList computer deployments
immybot_computers_trigger_checkinForce agent check-in

Software Tools

ToolDescription
immybot_software_list_globalList global software packages
immybot_software_listList all software (global + tenant)
immybot_software_getGet software details
immybot_software_searchSearch software by name
immybot_software_versionsList software versions
immybot_software_latest_versionGet latest version
immybot_software_categoriesList categories
immybot_software_publishersList publishers
immybot_software_installStage software installation
immybot_software_statsGet installation statistics

Error Handling

The server provides structured error responses:

json
{  "content": [{"type": "text", "text": "Error: Authentication failed"}],  "isError": true}

Common error types:

  • Authentication errors - Invalid credentials or expired tokens
  • Not found errors - Resource doesn't exist
  • Validation errors - Missing or invalid parameters
  • Rate limit errors - Too many requests
  • Server errors - Internal ImmyBot API issues

Development

Build from Source

bash
git clone https://github.com/WYRE-AI/immybot-mcp.gitcd immybot-mcpnpm installnpm run buildnpm start

Testing

bash
npm test

Docker Build

bash
docker build -t immybot-mcp --secret id=npmrc,src=$HOME/.npmrc .

The checked-in Compose file is gateway mode. It requires CONDUIT_S2S_SECRET and does not pass static IMMYBOT_* credentials.

Support

License

Apache-2.0 - see LICENSE for details.

来源:README.md,提交 dc8d0f0

工具

0
SourceWeft 曾在隔离沙箱中以无凭据方式启动该软件包一次,以列出其工具,但未能完成:该软件包类型无法在沙箱中运行。

版本历史

3
  1. v2.0.0最新Nov 20, 2026
  2. v1.2.14Oct 14, 2026
  3. v1.2.13Sep 16, 2026

评分

已满足适用检查项的 40%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分

    请在仓库或注册中心条目中声明许可证。