guniweb-sap-mcp 0.1.0

package/README.md

@@ -0,0 +1,125 @@
+# SAP S/4HANA MCP Server for n8n
+
+Connect n8n workflows to SAP S/4HANA via OData V2, V4, and IDocs using the Model Context Protocol (MCP).
+
+## Features
+
+- **OData V2 + V4 CRUD** -- Read, query, create, update, and delete SAP entities
+- **Deep Insert** -- Create parent and child entities in a single request (e.g., Sales Order with line items)
+- **Function Imports (V2) and Actions/Functions (V4)** -- Trigger SAP business logic
+- **Progressive Discovery** -- Discover services, inspect metadata, then execute operations
+- **IDoc Send & Receive** -- Send IDocs to SAP via HTTP/XML, receive via webhook
+- **Three Transport Modes** -- stdio (default), Streamable HTTP, and SSE for flexible deployment
+- **API Key Authentication** -- Secure HTTP transport with Bearer token authentication
+- **Docker Ready** -- Docker Compose example for n8n + SAP MCP sidecar deployment
+- **MCP Prompts** -- Pre-built conversation starters for common SAP tasks
+- **Selective Entity Set Exposure** -- Restrict visible entity sets with `--expose` glob patterns
+- **Auto Version Detection** -- Automatically detects OData V2 or V4 from service metadata
+- **Three Auth Modes** -- Basic Auth, OAuth 2.0 (BTP), API Key (Sandbox)
+- **ETag Handling** -- Automatic optimistic concurrency control
+- **Metadata Caching** -- Service metadata cached per session for performance
+
+## Quick Start
+
+### 1. Install
+
+```bash
+npm install -g guniweb-sap-mcp
+```
+
+Or run without installing:
+
+```bash
+npx guniweb-sap-mcp
+```
+
+### 2. Configure
+
+```bash
+export SAP_BASE_URL=https://your-sap-system.example.com
+export SAP_AUTH_TYPE=basic
+export SAP_USERNAME=your-user
+export SAP_PASSWORD=your-password
+export SAP_CLIENT=100
+```
+
+### 3. Run
+
+```bash
+# stdio (default) -- for n8n MCP Client in command mode
+guniweb-sap-mcp
+
+# HTTP -- for n8n MCP Client in URL mode or Docker
+guniweb-sap-mcp --transport http --port 8808
+
+# SSE -- for legacy MCP clients
+guniweb-sap-mcp --transport sse --port 8808
+```
+
+### 4. Use with n8n
+
+**Command mode (stdio):**
+
+1. Add an **MCP Client** node to your n8n workflow
+2. Set the command to: `guniweb-sap-mcp`
+3. Configure SAP environment variables in the node settings
+4. The AI agent can now use all SAP tools
+
+**URL mode (HTTP / Docker):**
+
+1. Start the server: `guniweb-sap-mcp --transport http --port 8808`
+2. Add an **MCP Client** node to your n8n workflow
+3. Set the URL to: `http://localhost:8808/mcp` (or `http://sap-mcp:8808/mcp` in Docker)
+4. If using `--api-key`, configure a Bearer token header
+
+## Transport Modes
+
+| Mode | Command | Use Case |
+|------|---------|----------|
+| stdio | `guniweb-sap-mcp` | n8n MCP Client (command mode) |
+| HTTP | `guniweb-sap-mcp --transport http` | n8n MCP Client (URL mode), Docker |
+| SSE | `guniweb-sap-mcp --transport sse` | Legacy MCP clients |
+
+HTTP transport is recommended for Docker deployments. See [Setup Guide](docs/setup-guide.md) for all CLI options.
+
+## Available Tools
+
+| Tool                 | Description                                      |
+|---------------------|--------------------------------------------------|
+| `test-connection`    | Test connectivity to the configured SAP system   |
+| `sap_list_services`  | Discover available entity sets in an OData service |
+| `sap_get_metadata`   | Inspect entity types, properties, keys, and navigation properties |
+| `sap_read`           | Read a single entity or collection               |
+| `sap_query`          | Query with filter, sort, pagination, expand       |
+| `sap_create`         | Create entities (supports deep insert)           |
+| `sap_update`         | Update entities (automatic ETag handling)        |
+| `sap_delete`         | Delete entities (automatic ETag handling)        |
+| `sap_function`       | Call V2 function imports or V4 actions/functions |
+| `sap_idoc_send`      | Send an IDoc to SAP via HTTP/XML                 |
+| `sap_idoc_list`      | List received IDocs from webhook                 |
+| `sap_idoc_status`    | Check IDoc processing status                     |
+
+## Supported SAP Systems
+
+- SAP S/4HANA Cloud
+- SAP S/4HANA On-Premise
+- SAP BTP Integration Suite
+- SAP API Business Hub Sandbox
+
+## Documentation
+
+- [Setup Guide](docs/setup-guide.md) -- Installation, configuration, transport modes, Docker deployment
+- [API Reference](docs/api-reference.md) -- All tools, resources, and prompts with parameters and examples
+- [Examples](docs/examples.md) -- Common SAP workflow examples with step-by-step instructions
+- [Docker Compose](docker-compose.yml) -- Ready-to-use n8n + SAP MCP deployment
+
+## Technology
+
+Built with:
+- [MCP TypeScript SDK](https://github.com/modelcontextprotocol/typescript-sdk) -- Model Context Protocol server runtime
+- [SAP Cloud SDK](https://github.com/SAP/cloud-sdk-js) -- SAP OData integration, auth, and connectivity
+- TypeScript, Node.js >= 22.18.0
+
+## License
+
+ISC

package/dist/index.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node