@compass-ai/mcp-sap-public-cloud
v1.0.13
Published
Compass AI SAP Public Cloud Connector for Model Context Protocol clients, with server, CLI, and TypeScript library support
Readme
Compass AI SAP Public Cloud Connector
Date: 2026-08-04
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.
Capabilities
- MCP server for MCP-compatible hosts
- Interactive CLI for inspecting and calling remote tools
- TypeScript/Node.js client library
- API-key authentication, timeouts, and retry handling
- Canonical
SAP_PUBLIC_CLOUD_*configuration variables - Deprecated
KORE_ERP_*and executable aliases for migration compatibility
Prerequisites
- Node.js 20 or later
- A Compass AI ERP Gateway endpoint connected to SAP Public Cloud
- An API key supplied by your Compass AI administrator
Installation
Run the MCP server with npx
npx --yes --package @compass-ai/mcp-sap-public-cloud@latest sap-public-cloud-connector --helpInstall globally
npm install --global @compass-ai/mcp-sap-public-cloud@latest
sap-public-cloud-connector --helpInstall as a project dependency
npm install @compass-ai/mcp-sap-public-cloud@latestQuick Start
Using as MCP Server
Connect 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:
Option 1: Using npx (recommended)
{
"mcpServers": {
"sap-public-cloud": {
"command": "npx",
"args": [
"--yes",
"--package",
"@compass-ai/mcp-sap-public-cloud@latest",
"sap-public-cloud-connector"
],
"env": {
"SAP_PUBLIC_CLOUD_URL": "https://your-erp-server.com",
"SAP_PUBLIC_CLOUD_ENDPOINT": "/mcp",
"SAP_PUBLIC_CLOUD_API_KEY": "your-api-key-here",
"SAP_PUBLIC_CLOUD_TIMEOUT": "30000",
"SAP_PUBLIC_CLOUD_RETRIES": "3"
}
}
}
}Option 2: Using a global installation and environment variables
{
"mcpServers": {
"sap-public-cloud": {
"command": "sap-public-cloud-connector",
"env": {
"SAP_PUBLIC_CLOUD_URL": "https://your-erp-server.com",
"SAP_PUBLIC_CLOUD_API_KEY": "your-api-key-here"
}
}
}
}After configuration, restart the MCP host and verify that the connector initializes successfully.
CLI Usage
Use 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.
# List all available tools
sap-public-cloud-client --url https://your-erp-server.com list-tools
# Initialize and inspect the remote server
sap-public-cloud-client --url https://your-erp-server.com init
# Call a tool
sap-public-cloud-client --url https://your-erp-server.com `
call GetCustomer --args '{"customerId": "12345"}'
# Run the client without a global installation
npx --package @compass-ai/mcp-sap-public-cloud@latest `
sap-public-cloud-client --url https://your-erp-server.com list-toolsProgrammatic Usage
Use the connector as a library in TypeScript/Node.js applications:
import { McpClient } from '@compass-ai/mcp-sap-public-cloud';
// Initialize client
const client = new McpClient('https://your-erp-server.com', '/mcp', {
apiKey: process.env.SAP_PUBLIC_CLOUD_API_KEY,
timeout: 30000,
retries: 3
});
// Connect to server
await client.initialize();
// List available tools
const tools = await client.listTools();
console.log('Available tools:', tools);
// Call a tool
const result = await client.callTool('GetCustomer', {
customerId: '12345'
});
console.log('Customer data:', result);
// Update API key dynamically
client.setApiKey('new-api-key');Configuration
MCP Server Options
Both CLI arguments and environment variables are supported:
| CLI Argument | Environment Variable | Default | Description |
|--------------|---------------------|---------|-------------|
| -u, --url | SAP_PUBLIC_CLOUD_URL | http://localhost:5000 | Base URL of the Compass AI ERP Gateway server |
| -e, --endpoint | SAP_PUBLIC_CLOUD_ENDPOINT | /mcp | MCP endpoint path |
| -k, --api-key | SAP_PUBLIC_CLOUD_API_KEY | - | API key for authentication |
| -t, --timeout | SAP_PUBLIC_CLOUD_TIMEOUT | 30000 | Request timeout in milliseconds |
| -r, --retries | SAP_PUBLIC_CLOUD_RETRIES | 3 | Number of retry attempts |
CLI 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.
CLI Commands
| Command | Description |
|---------|-------------|
| init | Initialize connection and display server information |
| list-tools | List all available ERP tools |
| call <toolName> | Call a specific tool with JSON arguments |
| interactive | Enter interactive mode with guided prompts |
Examples
Example 1: Call a tool from PowerShell
sap-public-cloud-client `
--url https://your-erp-server.com `
call GetCustomer `
--args '{"customerId":"12345"}'Example 2: Custom integration
import { McpClient } from '@compass-ai/mcp-sap-public-cloud';
const client = new McpClient(
process.env.SAP_PUBLIC_CLOUD_URL!,
process.env.SAP_PUBLIC_CLOUD_ENDPOINT ?? '/mcp',
{
apiKey: process.env.SAP_PUBLIC_CLOUD_API_KEY,
timeout: 30000,
retries: 3
}
);
await client.initialize();
const customer = await client.callTool('GetCustomer', {
customerId: '12345'
});Migration from kore-erpgateway-mcp
The scoped package moves the public distribution to @compass-ai/mcp-sap-public-cloud and standardizes the executable names.
| Deprecated alias | Canonical replacement |
|------------------|-----------------------|
| kore-erpgateway-mcp | sap-public-cloud-connector |
| kore-erp-mcp-server | sap-public-cloud-connector |
| mcp-client | sap-public-cloud-client |
The 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_*.
API Reference
McpClient Class
Constructor
constructor(
baseUrl: string,
endpoint: string = '/mcp',
options?: {
apiKey?: string;
timeout?: number;
retries?: number;
}
)Methods
| Method | Parameters | Returns | Description |
|--------|------------|---------|-------------|
| initialize() | - | Promise<McpServerInfo> | Connect to the MCP server and return negotiated server information |
| listTools() | - | Promise<McpTool[]> | Get the complete list of available ERP tools |
| callTool(name, args) | name: string, args: object | Promise<CallToolResult> | Execute a tool and preserve its complete MCP result |
| setApiKey(apiKey) | apiKey: string | void | Update the API key and reset the initialized session |
CLI Global Options
| Option | Description |
|--------|-------------|
| -u, --url <url> | MCP server URL |
| -k, --api-key <key> | API key for authentication |
| -e, --endpoint <path> | MCP endpoint path (default: /mcp) |
| -t, --timeout <ms> | Positive integer request timeout in milliseconds |
| -r, --retries <count> | Non-negative integer initialization retry count |
| --verbose | Enable diagnostic CLI output |
The call command accepts -a, --args <json>. Its value must be a JSON object.
Troubleshooting
Contact us here.
Connection Issues
Problem: Cannot connect to ERP server
sap-public-cloud-client `
--url https://your-erp-server.com `
initAuthentication Errors
Problem: 401 Unauthorized errors
- Ensure your API key is correct
- Check if the API key has proper permissions
- Verify the key hasn't expired
Timeout Errors
Problem: Requests timing out
sap-public-cloud-client `
--url https://your-erp-server.com `
--timeout 60000 `
list-toolsMCP Server Not Starting in Claude
- Check Claude Desktop logs for errors
- Verify the command path is correct
- Test the server manually:
sap-public-cloud-connector --url https://your-erp-server.com - Restart Claude Desktop after configuration changes
Common Error Messages
| Error | Cause | Solution |
|-------|-------|----------|
| ECONNREFUSED | Cannot reach server | Check URL and network connectivity |
| Invalid API key | Authentication failure | Verify API key is correct |
| Tool not found | Invalid tool name | Run list-tools to see available tools |
| Timeout | Request took too long | Increase timeout or check server performance |
Support
- Enterprise Support: Contact your Compass AI account representative
- Technical Documentation: Model Context Protocol
- API Access: Request credentials from your Compass AI administrator
- Issues & Feature Requests: Report via your organization's support channel
About Compass AI
Compass AI provides enterprise-grade AI agent infrastructure for secure automation across enterprise systems.
Contact Compass AI for enterprise licensing and deployment options.
Related Resources
- Compass Agentic Platform
- Compass Documentation
- Model Context Protocol SDK
- Anthropic MCP Documentation
- Claude Desktop
Co-authored by Nova
