@elastic.io/mcp

中文文档
1.0.0-beta8发布于 2026/11/12Apache-2.0TypeScriptES Module近 30 天下载 2795

elastic.io Model Context Protocol (MCP) Server

原始使用文档
文档目录15 节
  1. Terms of Use
  2. Quick Start
  3. Prerequisites
  4. One-Command Setup
  5. Supported Clients (Auto-Setup)
  6. Manual Configuration
  7. Local LLM Agents (Ollama, LM Studio, etc.)
  8. Environment Variables
  9. Update
  10. Uninstall
  11. 1. Remove the elasticio entry from your AI client configs
  12. 2. Clear the npx cache
  13. 3. Revoke your API key
  14. 4. Restart your AI clients
  15. Licence

elastic.io Model Context Protocol (MCP) Server

An MCP server that connects AI assistants to the elastic.io iPaaS platform — letting them discover, build, modify, and debug integration flows directly.

Terms of Use

The elastic.io MCP server is optional. By connecting an AI agent to elastic.io through it, you agree to the elastic.io Terms of Use, in particular the MCP Interface and AI agents section.

In short:

  • Your agent acts as you. Everything your AI agent does through MCP is done on behalf of your elastic.io account.
  • Limit its permissions. The agent can read, change and delete data within the permissions of the user account you connect. Use a dedicated user with only the permissions the agent needs, and read-only access wherever possible.
  • Your data goes to your AI provider. Data the agent reads is sent to the AI provider you use. You are responsible for your agreement with that provider.
  • We don't control your agent. elastic.io does not provide or control your AI agent and is not responsible for its actions or outputs.
  • We don't access your secrets. elastic.io does not read, view, store, or otherwise access your sensitive data such as tokens or credential passwords through the MCP server.
  • We don't use AI on your data. elastic.io does not use AI to process your data and does not use it to train AI models.

Quick Start

Prerequisites

  1. Node.js 22+ — download from nodejs.org

  2. A desktop AI client — install one of the supported clients (see below)

  3. elastic.io credentials — log in to your elastic.io account, go to your profile page, and click the example to copy the curl command to clipboard. The setup wizard accepts this command directly — just paste it when prompted.

    Where to find the curl command on your profile page

One-Command Setup

Run this in your terminal — it will detect your installed AI clients and configure them automatically:

macOS / Linux:

npx -y @elastic.io/mcp@beta setup

Windows (PowerShell):

npx -y "@elastic.io/mcp@beta" setup

Windows notes:

  • Always wrap the package name in quotes ("@elastic.io/mcp") — PowerShell misinterprets the @ symbol without them.
  • If you get a PSSecurityException error, allow script execution for your user first:
    Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy RemoteSigned
    

Works on macOS, Linux, and Windows. The setup wizard will:

  1. Check your Node.js version (22+ required)
  2. Accept the curl command from your profile page (or ask for email and API key manually)
  3. Detect which AI clients are installed on your machine
  4. Resolve the full path to node/npx (handles NVM, fnm, Homebrew, etc.)
  5. Write the MCP config files with correct paths for each client

After setup, restart your AI client — the elastic.io tools will appear in the chat.

Supported Clients (Auto-Setup)

The setup wizard automatically detects and configures these clients:

Claude Desktop, Claude Code, ChatGPT / Codex, Cursor, VS Code (Copilot), Windsurf, Gemini CLI / Gemini IDE, Zed, Cline, Trae, Qwen Code, Kimi Code, DeepSeek, etc.

Manual Configuration

If you prefer to configure manually or use a client not listed above, add the following to your client's MCP config file:

{
  "mcpServers": {
    "elasticio": {
      "command": "npx",
      "args": ["-y", "@elastic.io/mcp"],
      "env": {
        "ELASTICIO_API_EMAIL": "[email protected]",
        "ELASTICIO_API_KEY": "your_api_key",
        "ELASTICIO_API_BASE_URL": "https://api.elastic.io"
      }
    }
  }
}

Note: ChatGPT / Codex uses TOML format — use npx -y @elastic.io/mcp@beta setup for automatic configuration.

Local LLM Agents (Ollama, LM Studio, etc.)

Local LLM-based agents can connect to the elastic.io MCP server using the manual configuration above. However, please note:

  • Setup is manual only — the setup wizard does not auto-detect local LLM runtimes.
  • No official support — elastic.io does not test against or provide support for local LLM agents. Your experience will depend on the model's capabilities.
  • MCP client compatibility required — your local agent must support the MCP protocol (stdio transport) to connect.

Environment Variables

VariableRequiredDefaultDescription
ELASTICIO_API_EMAILyes—Your elastic.io account email
ELASTICIO_API_KEYyes—Your elastic.io API key
ELASTICIO_API_BASE_URLnohttps://api.elastic.ioBase URL for the elastic.io REST API

Update

To update to the latest version, clear the npx cache first, then run setup again:

# macOS / Linux
npx -y clear-npx-cache && npx -y @elastic.io/mcp@beta setup

# Windows (PowerShell)
npx -y clear-npx-cache; npx -y "@elastic.io/mcp@beta" setup

This ensures npx fetches the latest version from npm. Your credentials will be re-prompted. Restart your AI clients after the update.


Uninstall

To completely remove the elastic.io MCP server and its credentials from your machine:

1. Remove the elasticio entry from your AI client configs

Open the config file for each client you configured and delete the elasticio section. Config file locations:

ClientmacOSWindowsLinux
Claude Desktop~/Library/Application Support/Claude/claude_desktop_config.json%APPDATA%\Claude\claude_desktop_config.json~/.config/Claude/claude_desktop_config.json
Claude Code~/.claude.json~/.claude.json~/.claude.json
ChatGPT / Codex~/.codex/config.toml~/.codex/config.toml~/.codex/config.toml
VS Code (Copilot)~/Library/Application Support/Code/User/mcp.json%APPDATA%\Code\User\mcp.json~/.config/Code/User/mcp.json
Gemini CLI / Gemini IDE~/.gemini/config/mcp_config.json~/.gemini/config/mcp_config.json~/.gemini/config/mcp_config.json

For other clients (Cursor, Windsurf, Zed, Cline, Trae, Qwen Code, Kimi Code, DeepSeek, etc.), check your client's documentation for the MCP config file location and remove the elasticio entry.

2. Clear the npx cache

The MCP server binary is cached by npx. To remove it:

# macOS / Linux
npx -y clear-npx-cache
# or manually:
rm -rf ~/.npm/_npx

# Windows (PowerShell)
Remove-Item -Recurse -Force "$env:USERPROFILE\.npm\_npx"

3. Revoke your API key

Your elastic.io API key is stored in plain text in each config file listed above. After removing the config entries:

  1. Log in to your elastic.io account
  2. Go to your profile page
  3. Regenerate your API key

This invalidates the old key even if a copy remains on disk.

Security note: Keep your MCP credentials secret and revoke them without delay if you suspect they may have been compromised.

4. Restart your AI clients

Restart any AI clients that were configured to pick up the changes.


Licence

This package is open-source under the Apache 2.0 licence. Connecting it to the elastic.io platform is subject to the Terms of Use above.

版本与发布记录

@elastic.io/mcp 共发布 30 个版本,首次发布于 2026/09/30;过去 12 个月发布了 30 个版本。

版本发布日期距今
1.0.0-beta8latest2026/11/121 天前
1.0.0-beta72026/11/121 天前
1.0.0-beta62026/11/103 天前
1.0.0-beta52026/11/103 天前
1.0.0-beta42026/11/103 天前
1.0.0-beta32026/11/103 天前

其他发布通道:dev → 1.0.1-dev23,beta → 1.0.0-beta2。

关于 @elastic.io/mcp 的常见问题

@elastic.io/mcp 是什么?

elastic.io Model Context Protocol (MCP) Server

如何安装 @elastic.io/mcp?

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

@elastic.io/mcp 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@elastic.io/mcp 支持 ESM 还是 CommonJS?

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

@elastic.io/mcp 需要什么版本的 Node.js?

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

@elastic.io/mcp 可以商用吗?

@elastic.io/mcp 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@elastic.io/mcp 的下载量有多少?

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

@elastic.io/mcp 还在维护吗?

最新版本 1.0.0-beta8 发布于 2026/11/12(1 天前);至今共发布 30 个版本,其中过去 12 个月发布了 30 个;首次发布于 2026/09/30。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。