# @elgato/mcp-server 中文文档

规范地址：https://npmcn.com/package/%40elgato/mcp-server/

版本：0\.1\.8
npm 元数据更新时间：2026-10-01T10:46:54.865Z
中文译文更新时间：2026-11-13T12:25:53.458Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40elgato/mcp-server
原文对照：https://npmcn.com/package/%40elgato/mcp-server/?lang=original
项目主页：https://github.com/elgatosf/elgato-mcp-server#readme
源码仓库：https://github.com/elgatosf/elgato-mcp-server

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：426 kB，32 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=18\.0\.0
- 运行依赖：4 个
- 首次发布：2026-02-20T13:22:22.006Z
- 最新版本发布：2026-10-01T10:46:54.541Z
- 近 30 天下载量：31659（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 10 个）

## 中文简介

一个模型背景协议(MCP)服务器,将AI助手与Elgato app相接.

## 安装

```sh
npm install @elgato/mcp-server
```

也可以使用：`pnpm add @elgato/mcp-server`、`yarn add @elgato/mcp-server`、`bun add @elgato/mcp-server`

## README

# Elgato MCP 服务器

[![npm version](https://img.shields.io/npm/v/@elgato/mcp-server.svg)](https://www.npmjs.com/package/@elgato/mcp-server) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

一个模型上下文协议(MCP)服务器,将AI助手(如克洛德桌面)与Elgato apps相接.

## 概览

Elgato MCP 服务器作为 MCP 客户端和 Elgato apps之间的协议桥梁,通过 IPC :

```
MCP Client <--MCP Transport--> Bridge <--Unix Socket/Named Pipe--> Elgato App
```

**关键特性 :**

-   🔌 **动态工具发现** ——通过MCP自动从连接的Elgato应用程序中发现并曝光工具
-   🚀 **双重运输支助** – stdio(供克洛德桌面使用)和HTTP(供网络客户端使用)
-   🌐 **ngrok 整合** ——可选公用地道实现远程接入
-   🔄 **热重接** ——应用程序可用时自动重联
-   💻 **横线** — 支持视窗和macOS
-   📢 **转发通知** ——将应用程序通知转发给连接的MCP客户端

## 安装

```bash
# Global installation (recommended)
npm install -g @elgato/mcp-server

# Or with pnpm
pnpm add -g @elgato/mcp-server
```

## 不安装运行

您可以直接运行 Elgato MCP 服务器, 而无需在全球安装 `npx`数字 :

```bash
# Run with stdio transport (default)
npx -y @elgato/mcp-server@latest

# Run with HTTP transport
npx -y @elgato/mcp-server@latest --http

# Run with HTTP transport on a custom port
npx -y @elgato/mcp-server@latest --http --port 3000

# Run with ngrok tunnel
NGROK_AUTHTOKEN=your_token npx -y @elgato/mcp-server@latest --http --ngrok

# Run with verbose logging
npx -y @elgato/mcp-server@latest --verbose
```

这对于试用没有永久安装的服务器或用于CI/CD环境都是有用的.

## 使用量

### stdio 运输( 默认)

与 Claude Desktop 或其他使用标准 I/O 的 MCP 客户端的集成:

```bash
elgato-mcp-server
```

### HTTP 运输

对于网络客户端或远程访问:

```bash
# Start HTTP server on default port (9090)
elgato-mcp-server --http

# Custom port
elgato-mcp-server --http --port 3000

# With ngrok tunnel (requires NGROK_AUTHTOKEN env var)
NGROK_AUTHTOKEN=your_token elgato-mcp-server --http --ngrok
```

### CLI 选项

```
Options:
  --transport <mode>  Transport mode: 'stdio' (default) or 'http'
  --http              Shorthand for --transport http
  --port <number>     HTTP server port (default: 9090)
  --ngrok             Enable ngrok tunnel (requires NGROK_AUTHTOKEN env var)
  --help, -h          Show help message
  --verbose, -v       Enable verbose logging (default: silent)
```

### 日志

日志以重度标签写入 stderr (`ERROR`, (中文(简体) ), `WARN`, (中文(简体) ), `INFO`, (中文(简体) ), `DEBUG`。错误和警告总是输出;信息/调试需要 `--verbose`。 。 。 .

## Claude 桌面配置

### 使用桌面扩展( 建议)

最容易安装的方法是包装桌面扩展(`.mcpb`包括克洛德桌面(Node.js),npm或互联网访问:

1.  下载最新 `elgato_stream_deck-<version>.mcpb` 从 [页 次](https://github.com/elgatosf/elgato-mcp-server/releases)。 。 。 .
2.  在 Claude 桌面中, 打开 **设置- 扩展** 拖动 `.mcpb` 文件输入窗口(或双击文件).
3.  确保Stream Deck app正在运行——其工具在连接后自动出现. 内置 `bridge_status` 工具随时报告连接状态.

或者,将服务器添加到您的 Claude 桌面配置文件中 :

**马科斯**数字 : `~/Library/Application Support/Claude/claude_desktop_config.json` **窗口**数字 : `%APPDATA%\Claude\claude_desktop_config.json`

### 使用全局安装

```json
{
    "mcpServers": {
        "elgato": {
            "command": "elgato-mcp-server"
        }
    }
}
```

### 使用 npx (不需要安装)

或者,你可以使用 `npx` 在不在全球安装的情况下运行服务器 :

```json
{
    "mcpServers": {
        "elgato": {
            "command": "npx",
            "args": ["--yes", "@elgato/mcp-server@latest"]
        }
    }
}
```

> **说明:** 基于npx的配置与Claude Desktop和其他支持stdio传输的MCP客户端合作. Npx下载软件包时,第一次运行可能需要时间.

## HTTP 终点

在 HTTP 模式下运行时,可以使用下列端点:

| 终点 | 方法 | 说明 |
| --- | --- | --- |
| `/mcp` | 邮政 | MCP 请求终点 |
| `/mcp` | 获取 | 用于流媒体的服务器-恒星事件( SSE) |
| `/mcp` | 迪莱特 | 闭会 |
| `/health` | 获取 | 健康检查终点 |

## 所需资源

-   使用 MCP 插件支持的 Elgato 应用程序( 如 Stream Deck)
-   节点.js 18或以后
-   支持的平台: Windows, macOS

## 隐私政策

此服务器完全运行在您的机器上, 并且仅与本地安装的 Elgato apps 通讯于本地的 IPC( macOS 上的 Unix sockets, 命名为 Windows 上的管) 。 它不收集、储存或向外部服务传送个人数据。 工具输入和输出在您的 MCP 客户端( 如 Claude Desktop) 和连接在同一机器上的 Elgato app 之间流动; 可选 ngrok 隧道只有在明确启用时才建立 `--ngrok`。 。 。 .

关于Elgato/Corsair的数据处理做法,见 [埃尔加托隐私政策](https://www.elgato.com/en/privacy-policy)。 。 。 .

## 捐款

我们欢迎捐款! 关于开发设置、编码准则和贡献过程,见 [捐款额](https://github.com/elgatosf/elgato-mcp-server/blob/main/CONTRIBUTING.md)。 。 。 .

详细技术文件和架构信息见 [技术规格.md](https://github.com/elgatosf/elgato-mcp-server/blob/main/TECHNICAL_SPECIFICATION.md)。 。 。 .

## 许可证

MIT许可证 - 版权 (c) Corsair Memory Inc.

见 [自由主义](https://github.com/elgatosf/elgato-mcp-server/blob/main/LICENSE) 详细情况.

## 链接

-   [GitHub 仓库](https://github.com/elgatosf/elgato-mcp-server)
-   [npm 软件包](https://www.npmjs.com/package/@elgato/mcp-server)
-   [问题跟踪器](https://github.com/elgatosf/elgato-mcp-server/issues)
-   [埃尔加多](https://www.elgato.com/)

## 常见问题

### @elgato/mcp-server 是什么？

一个模型背景协议\(MCP\)服务器,将AI助手与Elgato app相接\.

### 如何安装 @elgato/mcp-server？

在项目目录运行 npm install @elgato/mcp-server，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 elgato-mcp-server，可以用 npx elgato-mcp-server 直接运行。

### @elgato/mcp-server 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/elgato\_\_mcp-server 是否存在。

### @elgato/mcp-server 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @elgato/mcp-server 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @elgato/mcp-server 可以商用吗？

@elgato/mcp-server 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @elgato/mcp-server 的下载量有多少？

根据 npm 官方下载统计，@elgato/mcp-server 在 2026/10/14 – 2026/11/12 这 30 天内被下载 31,659 次，日均约 1,055 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @elgato/mcp-server 还在维护吗？

最新版本 0\.1\.8 发布于 2026/10/01（1 个月前）；至今共发布 10 个版本，其中过去 12 个月发布了 10 个；首次发布于 2026/02/20。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。