{"_id":"@compass-ai/mcp-sap-public-cloud","name":"@compass-ai/mcp-sap-public-cloud","dist-tags":{"latest":"1.0.13"},"versions":{"1.0.13":{"name":"@compass-ai/mcp-sap-public-cloud","version":"1.0.13","description":"Compass AI SAP Public Cloud Connector for Model Context Protocol clients, with server, CLI, and TypeScript library support","main":"dist/mcp-client.js","types":"dist/mcp-client.d.ts","exports":{".":{"types":"./dist/mcp-client.d.ts","require":"./dist/mcp-client.js","default":"./dist/mcp-client.js"}},"publishConfig":{"access":"public","tag":"latest"},"bin":{"mcp-sap-public-cloud":"dist/mcp-server.js","sap-public-cloud-connector":"dist/mcp-server.js","sap-public-cloud-client":"dist/cli.js","kore-erpgateway-mcp":"dist/legacy-server.js","kore-erp-mcp-server":"dist/legacy-server.js","mcp-client":"dist/legacy-client.js"},"scripts":{"build":"npm run clean && tsc && node scripts/minify-dist.cjs","start":"node dist/cli.js","start:server":"node dist/mcp-server.js","dev":"ts-node src/cli.ts","dev:server":"ts-node src/mcp-server.ts","clean":"rimraf dist","test":"npm run build && node --test \"test/*.test.cjs\"","release:pack":"node scripts/release-pack.cjs","verify:release":"node test/release-verification.cjs ./release/package.tgz"},"repository":{"type":"git","url":"https://oakpeak-devops@dev.azure.com/oakpeak-devops/Kore/_git/kore-erpgateway-mcp"},"keywords":["compass-ai","sap","sap-public-cloud","mcp","model-context-protocol","connector","cli","typescript","enterprise-resource-planning","mcp-server","llm","ai"],"author":"","license":"ISC","engines":{"node":">=20.0.0"},"type":"commonjs","dependencies":{"@modelcontextprotocol/sdk":"^1.20.0","axios":"^1.12.2","chalk":"^4.1.2","commander":"^14.0.1","inquirer":"^8.2.5"},"devDependencies":{"@types/inquirer":"^9.0.9","@types/node":"^24.7.1","rimraf":"^6.0.1","tar":"^7.5.22","terser":"^5.49.0","ts-node":"^10.9.2","typescript":"^5.9.3"},"_id":"@compass-ai/mcp-sap-public-cloud@1.0.13","_integrity":"sha512-t40pVOHgy7MEiGHcBweRQSf8Y7JRE0i+c/jWNmzkXfNC543HL+Ibc5+IuwsC3/TUk8cIxvkD4R4dDTsH3QgewQ==","_resolved":"C:\\Users\\TiagoDHerbe\\source\\repos\\Kore\\kore-erpgateway-mcp\\release\\package.tgz","_from":"file:release/package.tgz","_nodeVersion":"22.12.0","_npmVersion":"11.18.0","dist":{"integrity":"sha512-t40pVOHgy7MEiGHcBweRQSf8Y7JRE0i+c/jWNmzkXfNC543HL+Ibc5+IuwsC3/TUk8cIxvkD4R4dDTsH3QgewQ==","shasum":"b3e3a48279f8cbe20a82fe5149a2020aac5a7151","tarball":"https://registry.npmjs.org/@compass-ai/mcp-sap-public-cloud/-/mcp-sap-public-cloud-1.0.13.tgz","fileCount":22,"unpackedSize":55866,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDX61QbXip2myL5sQDfu/Ay60dHDCLq609/UCAtoOtyCwIhAJoBXv3uLXUxJdGfrnudLjEAwZCrkml5IkgmeG3tqYJI"}]},"_npmUser":{"name":"compass-ap","email":"brighten.kore.ai@gmail.com"},"directories":{},"maintainers":[{"name":"dherbe","email":"tiagodherbe@gmail.com"},{"name":"compass-ap","email":"brighten.kore.ai@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/mcp-sap-public-cloud_1.0.13_1785808932237_0.6208606284054481"},"_hasShrinkwrap":false}},"time":{"created":"2026-08-04T02:02:12.098Z","1.0.13":"2026-08-04T02:02:12.389Z","modified":"2026-08-04T02:02:12.777Z"},"maintainers":[{"name":"dherbe","email":"tiagodherbe@gmail.com"},{"name":"compass-ap","email":"brighten.kore.ai@gmail.com"}],"description":"Compass AI SAP Public Cloud Connector for Model Context Protocol clients, with server, CLI, and TypeScript library support","keywords":["compass-ai","sap","sap-public-cloud","mcp","model-context-protocol","connector","cli","typescript","enterprise-resource-planning","mcp-server","llm","ai"],"repository":{"type":"git","url":"https://oakpeak-devops@dev.azure.com/oakpeak-devops/Kore/_git/kore-erpgateway-mcp"},"license":"ISC","readme":"# Compass AI SAP Public Cloud Connector\r\n\r\nDate: 2026-08-04\r\n\r\n[![npm version](https://img.shields.io/npm/v/@compass-ai/mcp-sap-public-cloud.svg)](https://www.npmjs.com/package/@compass-ai/mcp-sap-public-cloud)\r\n[![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](https://opensource.org/licenses/ISC)\r\n[![Node.js Version](https://img.shields.io/node/v/@compass-ai/mcp-sap-public-cloud.svg)](https://nodejs.org)\r\n\r\n**Compass AI SAP Public Cloud Connector** connects Model Context Protocol (MCP) clients and Node.js applications to SAP Public Cloud through a Compass AI ERP Gateway endpoint.\r\n\r\n## Capabilities\r\n\r\n- MCP server for MCP-compatible hosts\r\n- Interactive CLI for inspecting and calling remote tools\r\n- TypeScript/Node.js client library\r\n- API-key authentication, timeouts, and retry handling\r\n- Canonical `SAP_PUBLIC_CLOUD_*` configuration variables\r\n- Deprecated `KORE_ERP_*` and executable aliases for migration compatibility\r\n\r\n## Prerequisites\r\n\r\n- Node.js 20 or later\r\n- A Compass AI ERP Gateway endpoint connected to SAP Public Cloud\r\n- An API key supplied by your Compass AI administrator\r\n\r\n## Installation\r\n\r\n### Run the MCP server with npx\r\n\r\n```bash\r\nnpx --yes --package @compass-ai/mcp-sap-public-cloud@latest sap-public-cloud-connector --help\r\n```\r\n\r\n### Install globally\r\n\r\n```bash\r\nnpm install --global @compass-ai/mcp-sap-public-cloud@latest\r\nsap-public-cloud-connector --help\r\n```\r\n\r\n### Install as a project dependency\r\n\r\n```bash\r\nnpm install @compass-ai/mcp-sap-public-cloud@latest\r\n```\r\n\r\n## Quick Start\r\n\r\n### Using as MCP Server\r\n\r\nConnect an MCP-compatible host to SAP Public Cloud through the Compass AI SAP Public Cloud Connector. For Claude Desktop, add this configuration to `claude_desktop_config.json`:\r\n\r\n**Option 1: Using npx (recommended)**\r\n\r\n```json\r\n{\r\n  \"mcpServers\": {\r\n    \"sap-public-cloud\": {\r\n      \"command\": \"npx\",\r\n      \"args\": [\r\n        \"--yes\",\r\n        \"--package\",\r\n        \"@compass-ai/mcp-sap-public-cloud@latest\",\r\n        \"sap-public-cloud-connector\"\r\n      ],\r\n      \"env\": {\r\n        \"SAP_PUBLIC_CLOUD_URL\": \"https://your-erp-server.com\",\r\n        \"SAP_PUBLIC_CLOUD_ENDPOINT\": \"/mcp\",\r\n        \"SAP_PUBLIC_CLOUD_API_KEY\": \"your-api-key-here\",\r\n        \"SAP_PUBLIC_CLOUD_TIMEOUT\": \"30000\",\r\n        \"SAP_PUBLIC_CLOUD_RETRIES\": \"3\"\r\n      }\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n**Option 2: Using a global installation and environment variables**\r\n\r\n```json\r\n{\r\n  \"mcpServers\": {\r\n    \"sap-public-cloud\": {\r\n      \"command\": \"sap-public-cloud-connector\",\r\n      \"env\": {\r\n        \"SAP_PUBLIC_CLOUD_URL\": \"https://your-erp-server.com\",\r\n        \"SAP_PUBLIC_CLOUD_API_KEY\": \"your-api-key-here\"\r\n      }\r\n    }\r\n  }\r\n}\r\n```\r\n\r\nAfter configuration, restart the MCP host and verify that the connector initializes successfully.\r\n\r\n### CLI Usage\r\n\r\nUse `sap-public-cloud-client` for direct interaction with the remote MCP endpoint. Set `SAP_PUBLIC_CLOUD_API_KEY` in the process environment — preferably through your secret manager — rather than passing it as a command argument.\r\n\r\n```powershell\r\n# List all available tools\r\nsap-public-cloud-client --url https://your-erp-server.com list-tools\r\n\r\n# Initialize and inspect the remote server\r\nsap-public-cloud-client --url https://your-erp-server.com init\r\n\r\n# Call a tool\r\nsap-public-cloud-client --url https://your-erp-server.com `\r\n  call GetCustomer --args '{\"customerId\": \"12345\"}'\r\n\r\n# Run the client without a global installation\r\nnpx --package @compass-ai/mcp-sap-public-cloud@latest `\r\n  sap-public-cloud-client --url https://your-erp-server.com list-tools\r\n```\r\n\r\n### Programmatic Usage\r\n\r\nUse the connector as a library in TypeScript/Node.js applications:\r\n\r\n```typescript\r\nimport { McpClient } from '@compass-ai/mcp-sap-public-cloud';\r\n\r\n// Initialize client\r\nconst client = new McpClient('https://your-erp-server.com', '/mcp', {\r\n  apiKey: process.env.SAP_PUBLIC_CLOUD_API_KEY,\r\n  timeout: 30000,\r\n  retries: 3\r\n});\r\n\r\n// Connect to server\r\nawait client.initialize();\r\n\r\n// List available tools\r\nconst tools = await client.listTools();\r\nconsole.log('Available tools:', tools);\r\n\r\n// Call a tool\r\nconst result = await client.callTool('GetCustomer', {\r\n  customerId: '12345'\r\n});\r\nconsole.log('Customer data:', result);\r\n\r\n// Update API key dynamically\r\nclient.setApiKey('new-api-key');\r\n```\r\n\r\n## Configuration\r\n\r\n### MCP Server Options\r\n\r\nBoth CLI arguments and environment variables are supported:\r\n\r\n| CLI Argument | Environment Variable | Default | Description |\r\n|--------------|---------------------|---------|-------------|\r\n| `-u, --url` | `SAP_PUBLIC_CLOUD_URL` | `http://localhost:5000` | Base URL of the Compass AI ERP Gateway server |\r\n| `-e, --endpoint` | `SAP_PUBLIC_CLOUD_ENDPOINT` | `/mcp` | MCP endpoint path |\r\n| `-k, --api-key` | `SAP_PUBLIC_CLOUD_API_KEY` | - | API key for authentication |\r\n| `-t, --timeout` | `SAP_PUBLIC_CLOUD_TIMEOUT` | `30000` | Request timeout in milliseconds |\r\n| `-r, --retries` | `SAP_PUBLIC_CLOUD_RETRIES` | `3` | Number of retry attempts |\r\n\r\nCLI arguments take precedence over environment variables. The legacy `KORE_ERP_URL`, `KORE_ERP_ENDPOINT`, `KORE_ERP_API_KEY`, `KORE_ERP_TIMEOUT`, and `KORE_ERP_RETRIES` variables remain supported as fallbacks.\r\n\r\n### CLI Commands\r\n\r\n| Command | Description |\r\n|---------|-------------|\r\n| `init` | Initialize connection and display server information |\r\n| `list-tools` | List all available ERP tools |\r\n| `call <toolName>` | Call a specific tool with JSON arguments |\r\n| `interactive` | Enter interactive mode with guided prompts |\r\n\r\n## Examples\r\n\r\n### Example 1: Call a tool from PowerShell\r\n\r\n```powershell\r\nsap-public-cloud-client `\r\n  --url https://your-erp-server.com `\r\n  call GetCustomer `\r\n  --args '{\"customerId\":\"12345\"}'\r\n```\r\n\r\n### Example 2: Custom integration\r\n\r\n```typescript\r\nimport { McpClient } from '@compass-ai/mcp-sap-public-cloud';\r\n\r\nconst client = new McpClient(\r\n  process.env.SAP_PUBLIC_CLOUD_URL!,\r\n  process.env.SAP_PUBLIC_CLOUD_ENDPOINT ?? '/mcp',\r\n  {\r\n    apiKey: process.env.SAP_PUBLIC_CLOUD_API_KEY,\r\n    timeout: 30000,\r\n    retries: 3\r\n  }\r\n);\r\n\r\nawait client.initialize();\r\nconst customer = await client.callTool('GetCustomer', {\r\n  customerId: '12345'\r\n});\r\n```\r\n\r\n## Migration from `kore-erpgateway-mcp`\r\n\r\nThe scoped package moves the public distribution to `@compass-ai/mcp-sap-public-cloud` and standardizes the executable names.\r\n\r\n| Deprecated alias | Canonical replacement |\r\n|------------------|-----------------------|\r\n| `kore-erpgateway-mcp` | `sap-public-cloud-connector` |\r\n| `kore-erp-mcp-server` | `sap-public-cloud-connector` |\r\n| `mcp-client` | `sap-public-cloud-client` |\r\n\r\nThe deprecated aliases emit a warning and then run the canonical implementation. Existing `KORE_ERP_*` environment variables also continue to work as fallbacks, but new configuration should use `SAP_PUBLIC_CLOUD_*`.\r\n\r\n## API Reference\r\n\r\n### McpClient Class\r\n\r\n#### Constructor\r\n\r\n```typescript\r\nconstructor(\r\n  baseUrl: string,\r\n  endpoint: string = '/mcp',\r\n  options?: {\r\n    apiKey?: string;\r\n    timeout?: number;\r\n    retries?: number;\r\n  }\r\n)\r\n```\r\n\r\n#### Methods\r\n\r\n| Method | Parameters | Returns | Description |\r\n|--------|------------|---------|-------------|\r\n| `initialize()` | - | `Promise<McpServerInfo>` | Connect to the MCP server and return negotiated server information |\r\n| `listTools()` | - | `Promise<McpTool[]>` | Get the complete list of available ERP tools |\r\n| `callTool(name, args)` | `name: string, args: object` | `Promise<CallToolResult>` | Execute a tool and preserve its complete MCP result |\r\n| `setApiKey(apiKey)` | `apiKey: string` | `void` | Update the API key and reset the initialized session |\r\n\r\n### CLI Global Options\r\n\r\n| Option | Description |\r\n|--------|-------------|\r\n| `-u, --url <url>` | MCP server URL |\r\n| `-k, --api-key <key>` | API key for authentication |\r\n| `-e, --endpoint <path>` | MCP endpoint path (default: `/mcp`) |\r\n| `-t, --timeout <ms>` | Positive integer request timeout in milliseconds |\r\n| `-r, --retries <count>` | Non-negative integer initialization retry count |\r\n| `--verbose` | Enable diagnostic CLI output |\r\n\r\nThe `call` command accepts `-a, --args <json>`. Its value must be a JSON object.\r\n\r\n## Troubleshooting\r\n\r\nContact us <a href=\"https://www.linkedin.com/company/compass-ap/\" target=\"_blank\">here</a>.\r\n\r\n### Connection Issues\r\n\r\n**Problem:** Cannot connect to ERP server\r\n\r\n```powershell\r\nsap-public-cloud-client `\r\n  --url https://your-erp-server.com `\r\n  init\r\n```\r\n\r\n### Authentication Errors\r\n\r\n**Problem:** 401 Unauthorized errors\r\n\r\n- Ensure your API key is correct\r\n- Check if the API key has proper permissions\r\n- Verify the key hasn't expired\r\n\r\n### Timeout Errors\r\n\r\n**Problem:** Requests timing out\r\n\r\n```powershell\r\nsap-public-cloud-client `\r\n  --url https://your-erp-server.com `\r\n  --timeout 60000 `\r\n  list-tools\r\n```\r\n\r\n### MCP Server Not Starting in Claude\r\n\r\n1. Check Claude Desktop logs for errors\r\n2. Verify the command path is correct\r\n3. Test the server manually:\r\n   ```powershell\r\n   sap-public-cloud-connector --url https://your-erp-server.com\r\n   ```\r\n4. Restart Claude Desktop after configuration changes\r\n\r\n### Common Error Messages\r\n\r\n| Error | Cause | Solution |\r\n|-------|-------|----------|\r\n| `ECONNREFUSED` | Cannot reach server | Check URL and network connectivity |\r\n| `Invalid API key` | Authentication failure | Verify API key is correct |\r\n| `Tool not found` | Invalid tool name | Run `list-tools` to see available tools |\r\n| `Timeout` | Request took too long | Increase timeout or check server performance |\r\n\r\n## Support\r\n\r\n- **Enterprise Support:** Contact your Compass AI account representative\r\n- **Technical Documentation:** [Model Context Protocol](https://modelcontextprotocol.io/)\r\n- **API Access:** Request credentials from your Compass AI administrator\r\n- **Issues & Feature Requests:** Report via your organization's support channel\r\n\r\n## About Compass AI\r\n\r\nCompass AI provides enterprise-grade AI agent infrastructure for secure automation across enterprise systems.\r\n\r\nContact Compass AI for enterprise licensing and deployment options.\r\n\r\n## Related Resources\r\n\r\n- [Compass Agentic Platform](https://compassap.ai/)\r\n- [Compass Documentation](https://brightendigital.github.io/kore/)\r\n- [Model Context Protocol SDK](https://github.com/modelcontextprotocol/typescript-sdk)\r\n- [Anthropic MCP Documentation](https://docs.anthropic.com/en/docs/agents-and-tools/mcp)\r\n- [Claude Desktop](https://claude.ai/desktop)\r\n\r\n---\r\nCo-authored by [Nova](https://www.compassap.ai/portfolio/nova.html)\r\n","readmeFilename":"readme.md","_rev":"1-43a9ee39adb55fe37c86aa46f48a9556"}