Odata MCP Proxy
No description available
Ask AI about Odata MCP Proxy
Powered by Claude Β· Grounded in docs
I know everything about Odata MCP Proxy. Ask me about installation, configuration, usage, or troubleshooting.
0/500
Reviews
Documentation
OData MCP Proxy
A config-driven MCP (Model Context Protocol) server that exposes OData and REST APIs as MCP tools. This enables AI assistants such as Claude to query, manage, and monitor SAP backends through natural language.
The server runs on SAP BTP Cloud Foundry and uses BTP Destinations for secure, token-managed connectivity to OData APIs.
Features
- 32 OData entity sets across 6 API categories, automatically registered as MCP tools
- Full CRUD support -- list, get, create, update, and delete operations where the API permits
- OData V2 query capabilities --
$filter,$select,$expand,$orderby,$top,$skip, and$inlinecount - Navigation property traversal -- dedicated tools for related entities (e.g., iFlow configurations, message attachments, error details)
- Category-based filtering -- enable only the API categories you need via configuration
- Dual transport modes -- Streamable HTTP for BTP deployment, stdio for local Claude Desktop use
- Automatic OAuth token management -- tokens are refreshed transparently via the BTP Destination Service
Architecture
Claude / AI Assistant
|
| MCP Protocol (stdio or HTTP)
v
OData MCP Proxy
|
| OData V2 + JSON
v
OData Client
|
| OAuth2 (via BTP Destination Service)
v
BTP Destination
|
v
SAP Cloud Integration
OData Admin APIs
The server resolves a BTP Destination at startup to obtain the Cloud Integration tenant URL and OAuth2 credentials. On each API call, the destination is re-resolved to ensure tokens remain valid. The OData client translates MCP tool invocations into OData V2 HTTP requests and returns structured JSON results to the AI assistant.
Prerequisites
- Node.js 20+ (18+ minimum, 20+ recommended)
- SAP BTP account with a Cloud Foundry environment
- SAP Integration Suite tenant (Cloud Integration capability)
- BTP Destination configured to point to your Cloud Integration tenant's OData API with OAuth2 authentication
- Cloud Foundry CLI (
cf) and MBT Build Tool (mbt) for BTP deployment
Quick Start (Local Development)
1. Clone and install
git clone <repository-url>
cd odata-mcp-proxy
npm install
2. Configure environment
cp .env.example .env
Edit .env and set at minimum:
SAP_DESTINATION_NAME=your_ci_destination_name
MCP_TRANSPORT=stdio
Note: For local development with stdio transport, you must have BTP Destination Service credentials available in your environment (e.g., via
VCAP_SERVICESor adefault-env.jsonfile).
3. Build and run
npm run build
npm run start:stdio
Or use the development watcher:
npm run dev
4. Connect from Claude Desktop
Add the server to your Claude Desktop MCP configuration (claude_desktop_config.json):
{
"mcpServers": {
"odata-mcp-proxy": {
"command": "node",
"args": ["dist/index.js"],
"cwd": "/path/to/odata-mcp-proxy",
"env": {
"SAP_DESTINATION_NAME": "your_ci_destination_name",
"MCP_TRANSPORT": "stdio"
}
}
}
}
Using as an npm Package
You can consume odata-mcp-proxy as a dependency in your own project -- similar to how the SAP Application Router works. No TypeScript compilation or build step required.
1. Create your project
mkdir my-mcp-server
cd my-mcp-server
npm init -y
npm install odata-mcp-proxy
2. Add a start script
In your package.json:
{
"scripts": {
"start": "odata-mcp-proxy"
},
"dependencies": {
"odata-mcp-proxy": "^1.0.0"
}
}
3. Add your API config
Create an api-config.json in your project root. The CLI automatically picks it up from the working directory. See the bundled config files for the full format.
{
"server": {
"name": "my-mcp-server",
"version": "1.0.0",
"description": "My custom MCP server"
},
"apis": [
{
"name": "my-api",
"destination": "MY_DESTINATION",
"pathPrefix": "/api/v1",
"csrfProtected": true,
"entitySets": [
{
"entitySet": "Products",
"description": "product entities",
"category": "master-data",
"keys": [{ "name": "Id", "type": "string" }],
"operations": { "list": true, "get": true, "create": false, "update": false, "delete": false }
}
]
}
]
}
You can also use a custom filename with the --config flag:
odata-mcp-proxy --config my-custom-config.json
Or set it via environment variable:
API_CONFIG_FILE=my-custom-config.json npm start
If no config file is found in the working directory, the bundled defaults (SAP Cloud Integration APIs) are used.
4. Configure credentials
For local development, create a .env file or default-env.json with your destination credentials. The env var prefix is derived from the destination field in your config -- uppercase it and replace non-alphanumeric characters with _.
For example, destination "MY_DESTINATION" maps to:
MY_DESTINATION_BASE_URL=https://my-api.example.com
MY_DESTINATION_TOKEN_URL=https://auth.example.com/oauth/token
MY_DESTINATION_CLIENT_ID=...
MY_DESTINATION_CLIENT_SECRET=...
On BTP, use the Destination Service instead (credentials are resolved automatically via VCAP_SERVICES).
5. Project structure
A complete consumer project looks like this:
my-mcp-server/
βββ package.json # start script + dependency
βββ api-config.json # your API configuration
βββ default-env.json # local BTP credentials (gitignored)
βββ .env # local env overrides (gitignored)
βββ mta.yaml # BTP deployment descriptor
βββ xs-security.json # XSUAA config (if using OAuth)
Deploying to BTP as a consumer project
Since there is no build step, the mta.yaml is straightforward -- just like the SAP Application Router:
_schema-version: "3.1"
ID: my-mcp-server
version: 1.0.0
parameters:
enable-parallel-deployments: true
modules:
- name: my-mcp-server
type: nodejs
path: .
parameters:
memory: 512M
disk-quota: 1G
buildpack: nodejs_buildpack
health-check-type: http
health-check-http-endpoint: /health
command: npm start
build-parameters:
builder: npm
ignore:
- .git/
- .env
- default-env.json
requires:
- name: my-destination
- name: my-connectivity
- name: my-xsuaa
resources:
- name: my-destination
type: org.cloudfoundry.managed-service
parameters:
service: destination
service-plan: lite
- name: my-connectivity
type: org.cloudfoundry.managed-service
parameters:
service: connectivity
service-plan: lite
- name: my-xsuaa
type: org.cloudfoundry.managed-service
parameters:
service: xsuaa
service-plan: application
path: xs-security.json
The key difference from a standalone deployment: builder: npm is all you need. MBT runs npm install --production, which installs the pre-built odata-mcp-proxy package from the registry. No TypeScript, no custom build commands.
Deploy with:
mbt build && cf deploy mta_archives/my-mcp-server_1.0.0.mtar
BTP Deployment (Standalone)
When working with the source repository directly (not as an npm dependency), the project includes its own mta.yaml for deployment to SAP BTP Cloud Foundry. The MTA provisions the required service instances (Destination, Connectivity, XSUAA) and deploys the server as a Node.js application using HTTP transport.
npm run build:btp # Build the MTA archive
npm run deploy:btp # Deploy to Cloud Foundry
For detailed deployment instructions, destination configuration, and XSUAA setup, see docs/DEPLOYMENT.md.
Configuration
All configuration is managed through environment variables. The server validates configuration at startup using Zod and fails fast on invalid values.
| Variable | Required | Default | Description |
|---|---|---|---|
SAP_DESTINATION_NAME | Yes | -- | BTP Destination name pointing to your Cloud Integration tenant |
MCP_TRANSPORT | No | http | Transport mode: http (BTP deployment) or stdio (Claude Desktop) |
PORT | No | 4004 | HTTP server port (only used when MCP_TRANSPORT=http) |
LOG_LEVEL | No | info | Logging level: error, warn, info, debug |
REQUEST_TIMEOUT | No | 60000 | HTTP request timeout in milliseconds |
ENABLED_API_CATEGORIES | No | all | Comma-separated list of API categories to enable (see below) |
API Categories
Use ENABLED_API_CATEGORIES to restrict which tool groups are registered:
| Category | Description |
|---|---|
integration-content | Integration packages, iFlows, value/message mappings, script collections, custom tags, deploy status |
message-processing-logs | Message processing logs, ID mappings, idempotent repository |
message-stores | Data stores, variables, number ranges, message stores, JMS brokers and queues |
log-files | System log files and log file archives |
security-content | Keystores, certificates, SSH keys, credentials, OAuth2 clients, secure parameters, access policies |
partner-directory | Partners, string/binary parameters, alternative partners, authorized users |
Set to all (the default) to enable every category.
Available Tools
Tools are dynamically generated from entity set definitions. Each entity set produces up to five tools (_list, _get, _create, _update, _delete) plus navigation property tools, depending on what the OData API supports.
Integration Content
| Tool | Operations |
|---|---|
IntegrationPackages | list, get, create, update, delete |
IntegrationDesigntimeArtifacts | list, get, create, update, delete + Resources, Configurations |
IntegrationRuntimeArtifacts | list, get |
ValueMappingDesigntimeArtifacts | list, get, create, update, delete + ValMapSchema |
MessageMappingDesigntimeArtifacts | list, get, create, update, delete |
ScriptCollectionDesigntimeArtifacts | list, get, create, update, delete |
CustomTagConfigurations | list, get, create, update, delete |
BuildAndDeployStatus | list, get |
Message Processing Logs
| Tool | Operations |
|---|---|
MessageProcessingLogs | list, get + Attachments, ErrorInformations, AdapterAttributes, CustomHeaderProperties, MessageStoreEntries |
IdMapFromId2s | list |
IdempotentRepositoryEntries | list |
Message Stores
| Tool | Operations |
|---|---|
DataStoreEntries | list, get, delete |
Variables | list, get |
NumberRanges | list, get |
MessageStoreEntries | list, get |
JmsBrokers | list, get |
JmsResources | list |
Log Files
| Tool | Operations |
|---|---|
LogFiles | list, get |
LogFileArchives | list, get |
Security Content
| Tool | Operations |
|---|---|
KeystoreEntries | list, get, delete |
CertificateResources | list, get |
SSHKeyResources | list, get |
UserCredentials | list, get, create, update, delete |
OAuth2ClientCredentials | list, get, create, update, delete |
SecureParameters | list, get, create, update, delete |
CertificateUserMappings | list, get, create, update, delete |
AccessPolicies | list, get, create, update, delete + ArtifactReferences |
Partner Directory
| Tool | Operations |
|---|---|
Partners | list, get, create, update, delete |
StringParameters | list, get, create, update, delete |
BinaryParameters | list, get, create, update, delete |
AlternativePartners | list, get, create, update, delete |
AuthorizedUsers | list, get, create, update, delete |
Tool Naming Convention
Tools follow the pattern {EntitySet}_{operation}:
IntegrationPackages_list
IntegrationPackages_get
IntegrationPackages_create
IntegrationDesigntimeArtifacts_Configurations_list
MessageProcessingLogs_ErrorInformations_list
OData Query Parameters
All _list tools accept standard OData V2 query options:
$filter-- e.g.,"Status eq 'FAILED'"$select-- e.g.,"Id,Name,Status"$expand-- e.g.,"Configurations"$orderby-- e.g.,"Name asc"$top-- e.g.,10$skip-- e.g.,20
Transport Modes
HTTP (Streamable HTTP)
Used for BTP Cloud Foundry deployment. The server exposes an /mcp endpoint supporting the MCP Streamable HTTP transport with session management, plus a /health endpoint for CF health checks.
MCP_TRANSPORT=http PORT=4004 npm start
stdio
Used for local development and direct integration with Claude Desktop. Communication happens over standard input/output streams.
MCP_TRANSPORT=stdio npm start
Tech Stack
- Runtime: Node.js 20+ with ES Modules
- Language: TypeScript 5.7+
- MCP SDK:
@modelcontextprotocol/sdk1.17+ - SAP Cloud SDK:
@sap-cloud-sdk/connectivityand@sap-cloud-sdk/http-client4.x for destination resolution and HTTP calls - Validation: Zod for configuration and input validation
- HTTP Framework: Express 4.x (HTTP transport only)
- Logging: Winston
License
MIT
