@egain/egain-mcp-server 1.0.26 → 1.1.0

package/README.md

@@ -31,18 +31,19 @@ Learn more about the tools and usage of the MCP in the [eGain MCP guide](https:/
 - 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
-- A client application configured in your eGain tenant
+- **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).
+> ℹ️ 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
 
-### Step 1: Configure your MCP client (Cursor, Claude Desktop, Windsurf, VS Code, etc.) with the following:
+### Configure your MCP client
 
-**Note:** Replace `"..."` with your API domain (instructions in **Step 2**).
+Add this to your MCP client settings (Cursor, Claude Desktop, etc.), replacing `...` with your eGain API domain:
 
 ```json
 {
@@ -60,54 +61,28 @@ https://github.com/user-attachments/assets/2cecc8ff-6a90-4c26-92e1-6720f9124297
 }
 ```
 
-### Step 2: Find your API domain using the eGain Administrator Console
-1. Sign in as a Partition Admin → go to `Partition` → `Integration` → `Client Application`.
-2. Click `Metadata`. The value `API Domain` is detailed in the window.  
+<details>
+<summary><strong>How do I find my API domain?</strong></summary>
 
-Please contact your eGain PA if you do not have access to these admin-only details.
+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
 
-That's it! The MCP server will be automatically downloaded and run when needed.
+Contact your eGain PA if you do not have access to these admin-only details.
+</details>
 
-If you're having trouble configuring your MCP client, see these detailed guides:
-- Claude quick-start and example queries: [Claude Guide](./help/claude-example.md)
-- Cursor quick-start and example queries: [Cursor Guide](./help/cursor-example.md)
+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).
 
-### Step 3: Make a query and authenticate
+### Authenticate
 
-Once you've set up the server on your client, **run your first eGain MCP query** and a browser window will popup for authentication.
+https://github.com/user-attachments/assets/8df17bfa-141c-4f00-9412-5d3f6131574f
 
-**Requirements for authentication:**
-- A client application configured in your eGain tenant (some environments may have a pre-configured **APIs Trial** client app)
-- A supported browser (Chrome, Edge, or Brave — Safari is not supported)
-- Delegated API permissions in your client app:
-  - `knowledge.portalmgr.manage`
-  - `knowledge.portalmgr.read`
-  - `core.aiservices.read`
+On your first MCP query, a browser window will open for authentication.
 
-You'll need to enter your authentication configuration values in the browser form. For a tutorial, 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/) — **be sure to select SPA (Single Page Application) as the platform type**. Please contact your eGain PA if you do not have access to client application settings.
+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] -->
 
-## 🆘 Having Issues?
-
-Start here — most problems are covered in the FAQ:
-
-- **[FAQ & Troubleshooting](./help/faq.md)**
-- Authentication issues → [Authentication FAQ](./help/faq.md#authentication-issues)
-- Configuration issues → [Configuration FAQ](./help/faq.md#configuration-issues)
-- MCP tool issues → [Tool FAQ](./help/faq.md#mcp-tool-issues)
-
-### Token issues (expired or stuck)
-
-If authentication fails after it previously worked, delete cached token files and retry:
-
-```bash
-# Search your home directory for both token files
-find ~ -name ".bearer_token*" 2>/dev/null
-# Remove both token files
-rm /path/to/.bearer_token*
-```
-
 ## Debugging
 
 Use the MCP Inspector for interactive testing:
@@ -131,5 +106,7 @@ npx @modelcontextprotocol/inspector npx @egain/egain-mcp-server start --api-doma
 * 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)