btp-sap-odata-to-mcp-server-optimized

SAP OData to AI-Powered MCP Server (Optimized)

This repository is an enterprise-ready MCP (Model Context Protocol) server that bridges SAP OData services with AI capabilities. Based on the original project btp-sap-odata-to-mcp-server by @lemaiwo, this optimized version features enhanced security, simplified configuration, modular authentication, and comprehensive Cloud Foundry integration.

✨ Key Features

🔐 Enhanced Security Architecture

• Modular Authentication System: Factory pattern supporting IAS, OAuth2, JWT, Basic Auth, and API Keys
• Secure Session Management: Thread-safe session bridging with proper locking mechanisms
• Role-Based Access Control: Granular permissions with XSUAA integration
• Principal Propagation: Maintains user context throughout the request lifecycle
• Security Best Practices: No sensitive data logging, secure error handling, JWT validation

🎯 Simplified OData Discovery

• Pattern-Based Filtering: Simple include/exclude patterns for service discovery
• Business Domain Mode: Pre-configured domains (sales, finance, HR, etc.)
• Whitelist Mode: Explicit service control for production environments
• Smart Defaults: Automatic exclusion of test/debug services

🧠 AI-Powered Capabilities

• Smart Query Router: Natural language to OData conversion
• Hierarchical Tool Architecture: 17+ tools organized in logical layers
• Intelligent Workflow Orchestration: Automatic tool chaining and optimization
• Real-time Analytics: KPI monitoring and trend analysis

🎨 Interactive UI Tools Suite

• ui-form-generator: Dynamic SAP Fiori forms with validation
• ui-data-grid: Interactive tables with sorting and filtering
• ui-dashboard-composer: Real-time KPI dashboards
• ui-workflow-builder: Visual workflow creation
• ui-report-builder: Analytical reports with drill-down

☁️ Cloud-Native Features

• Cloud Foundry Optimized: Native integration with CF services
• Structured Logging: SAP Cloud Logging with fallback support
• Health Monitoring: Comprehensive health check endpoints
• Performance Metrics: Built-in performance tracking
• Graceful Shutdown: Proper resource cleanup

🚀 Quick Start

Prerequisites

• Access to an SAP BTP, Cloud Foundry environment.
• Required BTP services: XSUAA, Identity, Connectivity, Destination.
• Node.js >= 18.

1. Installation

git clone <this-repo>
cd btp-sap-odata-to-mcp-server-optimized
npm install

2. Configuration

Configure the application using environment variables. See the Configuration Guide for detailed documentation.

cp .env.example .env
# Edit .env with your configuration

Quick Configuration Example

# Authentication
SAP_IAS_URL=https://your-tenant.accounts.ondemand.com
SAP_IAS_CLIENT_ID=your-client-id
SAP_IAS_CLIENT_SECRET=your-secret

# OData Discovery (Simplified)
ODATA_DISCOVERY_MODE=pattern
ODATA_INCLUDE_PATTERNS=*API*,Z*
ODATA_EXCLUDE_PATTERNS=*_TEST*,*_TEMP*
ODATA_MAX_SERVICES=50

# Destinations
SAP_DESTINATION_NAME=SAP_S4HANA

3. Build and Deploy

# Build the TypeScript source code for BTP
npm run build:btp

# Deploy to SAP BTP, Cloud Foundry
npm run deploy:btp

📚 Documentation

Complete documentation is available with structured navigation for all aspects of the project.

🏠 Documentation Hub

Main navigation center with use-case-based guidance and complete file index.

🚀 Quick Links

Category	Document	Description
Getting Started	Configuration Guide	Environment setup, OData discovery, CF deployment
Architecture	Architecture Overview	System design, security model, tool hierarchy
🎨 Modern Diagrams	Modern Architecture Diagrams	NEW! Interactive visual architecture
Usage	User Guide	Authentication, tool usage, workflow examples
Reference	Tool Reference	Complete tool documentation with parameters
Deployment	Deployment Guide	SAP BTP and local development setup
Development	Testing Guide	Test suite and development guidelines
Changes	Changelog	Version history and feature updates

📖 Navigation Flow

README.md → docs/README.md → All Documentation
     ↓           ↓
Quick Start → Structured Navigation → Complete Coverage