# eGain MCP Server
Model Context Protocol (MCP) Server for the *egain-mcp-server*.

<div align="left">
    <a href="https://www.speakeasy.com/?utm_source=egain-mcp&utm_campaign=mcp-typescript"><img src="https://www.speakeasy.com/assets/badges/built-by-speakeasy.svg" /></a>
    <a href="https://opensource.org/licenses/MIT">
        <img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
    </a>
</div>
<br />


## Overview

This server implements the Model Context Protocol (MCP) for eGain Knowledge, exposing Portal Manager, Search, Retrieve, and Answers as a single MCP endpoint for AI clients.

It enables tools like Claude Desktop, Cursor, and VS Code to browse portals, read articles, search knowledge, submit suggestions, and generate AI-powered answers — all using the user’s existing eGain permissions.
> ⚠️ This MCP server is built exclusively for **eGain v4 APIs**. Earlier API versions are not supported. For more details about the v4 APIs, visit our [developer portal](https://apidev.egain.com/).


https://github.com/user-attachments/assets/1b6c8aab-eb50-4f9e-8dfc-2a9ac4fb6518

<!-- No Summary [summary] -->

Learn more about the tools and usage of the MCP in the [eGain MCP guide](https://apidev.egain.com/developer-portal/guides/mcp/mcp/).

<!-- No Table of Contents [toc] -->

### Prerequisites
- **Node.js 20+** (required to run the MCP server)
- eGain platform version **21.22 or newer**
- AI Services enabled for the tenant and target portal
- Knowledge portal and article content available
- **Supported browser:** Chrome, Edge, or Brave
- **Client application** configured in your eGain tenant (some environments have a pre-configured **APIs Trial** app)
- Delegated API permissions in your client app: `knowledge.portalmgr.manage`, `knowledge.portalmgr.read`, `core.aiservices.read`

> ℹ️ MCP access always mirrors the authenticated user's permissions (portal and article visibility).

## Installation

https://github.com/user-attachments/assets/2cecc8ff-6a90-4c26-92e1-6720f9124297

### Configure your MCP client

Add this to your MCP client settings (Cursor, Claude Desktop, etc.), replacing `...` with your eGain API domain:

```json
{
  "mcpServers": {
    "EgainMcp": {
      "command": "npx",
      "args": [
        "@egain/egain-mcp-server",
        "start",
        "--api-domain",
        "..."
      ]
    }
  }
}
```

<details>
<summary><strong>How do I find my API domain?</strong></summary>

1. Sign in to the eGain Administrator Console as a Partition Admin
2. Go to `Partition` → `Integration` → `Client Application` → `Metadata`
3. Copy the `API Domain` value

Contact your eGain PA if you do not have access to these admin-only details.
</details>

The MCP server will be automatically downloaded and run when needed. For client-specific setup, see the [Claude Guide](./help/claude-example.md) or [Cursor Guide](./help/cursor-example.md).

### Authenticate

https://github.com/user-attachments/assets/8df17bfa-141c-4f00-9412-5d3f6131574f

On your first MCP query, a browser window will open for authentication.

Enter your authentication configuration values in the browser form. For details, see the [Authentication Deep Dive](./help/authentication.md). If you need to create a client application, see the [API Authentication Guide](https://apidev.egain.com/developer-portal/get-started/authentication_guide/) — **select SPA (Single Page Application) as the platform type**.

<!-- No Installation [installation] -->

## Debugging

Use the MCP Inspector for interactive testing:

```bash
npx @modelcontextprotocol/inspector npx @egain/egain-mcp-server start --api-domain "..."
```

## Resources & Support
### Help Guides
- **[FAQ & Troubleshooting](./help/faq.md)**
- [What is MCP?](./help/what-is-mcp.md)
- [Authentication Deep Dive](./help/authentication.md)
- [Claude Example](./help/claude-example.md)
- [Cursor Example](./help/cursor-example.md)
- [BYO MCP Client LLM](./help/byo_llm_demo.ipynb)  
  

### Contact
* Issues: [GitHub Issues](https://github.com/eGain/egain-mcp-server/issues)
* eGain Support: [Support Portal](https://support.egain.com)
* MCP Support: eloh@egain.com

<!-- No Progressive Discovery [dynamic-mode] -->

<!-- Placeholder for Future Speakeasy SDK Sections -->
MCP Server Created by [Speakeasy](https://www.speakeasy.com/?utm_source=egain-mcp&utm_campaign=mcp-typescript)