{"_id":"@egain/egain-mcp-server","_rev":"23-315846d561e52ef8284054321d505cfd","name":"@egain/egain-mcp-server","dist-tags":{"latest":"1.1.1"},"versions":{"1.0.1":{"name":"@egain/egain-mcp-server","version":"1.0.1","author":{"name":"Emily Loh - eGain Corporation"},"_id":"@egain/egain-mcp-server@1.0.1","maintainers":[{"name":"eloh","email":"eloh@egain.com"},{"name":"akumar_egain","email":"akumar@egain.com"}],"bin":{"mcp":"bin/mcp-server.js","egain-mcp-server":"bin/mcp-server.js"},"dist":{"shasum":"d7444672b060349891423e05c24b449a582c9f72","tarball":"https://registry.npmjs.org/@egain/egain-mcp-server/-/egain-mcp-server-1.0.1.tgz","fileCount":693,"integrity":"sha512-cslRobG6n29mWVKfbdPpqmM3bUcT+m+Q6k5byM33Ey6m8KVGKMrILR6P5HoNm62aqhLreJ8qLF7ROerPxF6l/g==","signatures":[{"sig":"MEQCIFXfpRiPTlDLI4e2U3kNYkx3h+A9S88uhAW6TB045RuiAiB1bHRJmeZA8swnaMFeL+IxAULnIlAVh1KHhdF+v88PXg==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":6086366},"type":"module","gitHead":"3deb4393bab4faf46ec5e79ac466574cbc22a3f5","scripts":{"dev":"wrangler dev","lint":"eslint --cache --max-warnings=0 src","build":"bun i && bun src/mcp-server/build.mts && tsc","check":"npm run lint","types":"wrangler types","deploy":"wrangler deploy","prepublishOnly":"npm run build"},"_npmUser":{"name":"eloh","email":"eloh@egain.com"},"_npmVersion":"10.9.2","description":"
\n \n \n \n \n
\n
\n\n\n## Overview\n\nThis 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.\n\nIt 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.\n> ⚠️ 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/).\n\n\nhttps://github.com/user-attachments/assets/1b6c8aab-eb50-4f9e-8dfc-2a9ac4fb6518\n\n\n\nLearn more about the tools and usage of the MCP in the [eGain MCP guide](https://apidev.egain.com/developer-portal/guides/mcp/mcp/).\n\n\n\n### Prerequisites\n- **Node.js 20+** (required to run the MCP server)\n- eGain platform version **21.22 or newer**\n- AI Services enabled for the tenant and target portal\n- Knowledge portal and article content available\n- **Supported browser:** Chrome, Edge, or Brave\n- **Client application** configured in your eGain tenant (some environments have a pre-configured **APIs Trial** app)\n- Delegated API permissions in your client app: `knowledge.portalmgr.manage`, `knowledge.portalmgr.read`, `core.aiservices.read`\n\n> ℹ️ MCP access always mirrors the authenticated user's permissions (portal and article visibility).\n\n## Installation\n\nhttps://github.com/user-attachments/assets/2cecc8ff-6a90-4c26-92e1-6720f9124297\n\n### Configure your MCP client\n\nAdd this to your MCP client settings (Cursor, Claude Desktop, etc.), replacing `...` with your eGain API domain:\n\n```json\n{\n \"mcpServers\": {\n \"EgainMcp\": {\n \"command\": \"npx\",\n \"args\": [\n \"@egain/egain-mcp-server\",\n \"start\",\n \"--api-domain\",\n \"...\"\n ]\n }\n }\n}\n```\n\n
\nHow do I find my API domain?\n\n1. Sign in to the eGain Administrator Console as a Partition Admin\n2. Go to `Partition` → `Integration` → `Client Application` → `Metadata`\n3. Copy the `API Domain` value\n\nContact your eGain PA if you do not have access to these admin-only details.\n
\n\nThe 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).\n\n### Authenticate\n\nhttps://github.com/user-attachments/assets/8df17bfa-141c-4f00-9412-5d3f6131574f\n\nOn your first MCP query, a browser window will open for authentication.\n\nEnter 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**.\n\n\n\n## Debugging\n\nUse the MCP Inspector for interactive testing:\n\n```bash\nnpx @modelcontextprotocol/inspector npx @egain/egain-mcp-server start --api-domain \"...\"\n```\n\n## Resources & Support\n### Help Guides\n- **[FAQ & Troubleshooting](./help/faq.md)**\n- [What is MCP?](./help/what-is-mcp.md)\n- [Authentication Deep Dive](./help/authentication.md)\n- [Claude Example](./help/claude-example.md)\n- [Cursor Example](./help/cursor-example.md)\n- [BYO MCP Client LLM](./help/byo_llm_demo.ipynb) \n \n\n### Contact\n* Issues: [GitHub Issues](https://github.com/eGain/egain-mcp-server/issues)\n* eGain Support: [Support Portal](https://support.egain.com)\n* MCP Support: eloh@egain.com\n\n\n\n\nMCP Server Created by [Speakeasy](https://www.speakeasy.com/?utm_source=egain-mcp&utm_campaign=mcp-typescript)\n","readmeFilename":"README.md"}