SAP Datasphere MCP Server
The SAP Datasphere MCP Server enables AI assistants to interact with SAP Datasphere for comprehensive data tasks, with built-in PII masking.
Foundation & Security
Verify connection, OAuth authentication, current user, and tenant info.
Config-driven, fail-closed PII masking (redact, drop, hash, tokenize) before data reaches the LLM.
Discovery & Exploration
List and get details of spaces, tables, views, analytical models, and all catalog assets.
Search assets and repository objects with advanced query syntax (Boolean, scopes, filters).
Retrieve asset metadata, input parameters, relational entities, and OData service documents.
Data Querying & Analytics
Execute read-only SQL (SELECT) with automatic SQL-to-OData conversion.
Smart query routing (relational, analytical, SQL) with fallback and client-side aggregation.
Query analytical models with OData features ($select, $filter, $apply, $orderby, $top/$skip).
Extract relational data for ETL up to 50,000 records.
Lineage, Quality & Profiling
Find assets by column name for lineage and impact analysis.
Analyze column distributions: statistics, nulls, distinct values, percentiles, outlier detection.
User Management
List, create, update, delete database users; reset passwords (high-risk, requires consent).
Integration & Task Management
List external data connections (SAP ERP, Salesforce, etc.) and check status.
Run task chains, get task logs and execution history.
Browse data marketplace for external data packages.
Monitor deployed objects with runtime metrics.
Allows AI assistants to interact with SAP Datasphere environments for data discovery, metadata exploration, analytics operations, ETL data extraction, database user management, data lineage analysis, and column-level data profiling.
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@SAP Datasphere MCP Servershow all spaces in my Datasphere tenant"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
đ SAP Datasphere MCP Server
Production-ready Model Context Protocol (MCP) server that enables AI assistants to seamlessly interact with SAP Datasphere environments for real tenant data discovery, metadata exploration, analytics operations, ETL data extraction, database user management, data lineage analysis, and column-level data profiling â with built-in config-driven PII masking so sensitive fields never reach the LLM.
đĻ Which version do I install?
Package | MCP Python SDK | Status |
2.x (current) |
| Active development. Implements the 2026-07-28 stateless spec. |
1.x |
| Maintenance only â security and critical fixes. |
pip install sap-datasphere-mcp gives you 2.x. The 2.x server is dual-era: it answers both the modern server/discover handshake and the legacy initialize one, so 2025-era clients keep working without changes.
Stay on 1.x only if your environment cannot install SDK 2.x:
pip install 'sap-datasphere-mcp<2'Related MCP server: SAP Datasphere MCP Server
đ What's New (v2.0.1 â MCP SDK v2 / stateless spec)
Ported to MCP Python SDK 2.0.0 and the 2026-07-28 stateless specification. Handlers moved from the removed decorator API to
Server(on_*=âĻ)constructor kwargs. The dependency floor is nowmcp>=2.0,<3â this is why the package major changed.Dual-era by default â modern and legacy clients are both served from the same process; no configuration needed.
Response cache hints (
ttlMs/cacheScope, SEP-2549) ontools/list,prompts/listandresources/list, sourced fromCacheManagerso the protocol hint and the internal cache cannot drift. Hints are sent to modern clients only, as the spec requires.tools/listis deterministically ordered.Per-asset capability discovery â Datasphere capability varies per asset, not per tenant.
$countis now decided by reading the asset's ownCapabilities.CountRestrictionsannotation rather than a blanket rule, and a lineage-gated filter verdict is remembered per asset instead of being rediscovered on every call.Every 1.7.0 protection forward-ported, verified by the same test suite running green on both SDK lines. See
CHANGELOG_v2.0.1.md.
đ What's New (v1.7.0 â input validation hardening)
Every tool with inputs now has validation rules â 12 tools shipped without any, including
query_relational_entityandsmart_query. Coverage is 45/45 tools, 145/150 inputs.Path identifiers are constrained and percent-encoded.
space_id/asset_id/entity_name/object_idare interpolated into URL paths; they now reject traversal-shaped values and pass throughquote()as a backstop.Two silent-no-op bugs fixed â the validator registry had drifted so two tools' rules never ran, and
allowed_valueswas ignored onSTRINGrules (which also leftget_catalog_metadata.endpoint_typeunenforced).A CI guard now fails if a tool ships without validation rules. See
CHANGELOG_v1.7.0.md.
đ What's New (v1.6.0 â partial text matching in $filter)
startswith/endswith/containsare now supported in$filteron the Consumption API, so an agent can match on partial values instead of first listing distinct ones. Example:startswith(Product,'TV') and Country eq 'US'.Filtering is case-sensitive â
'us'does not match'US'. Verified against a live tenant; there is no server-side workaround, astolower()is not in the supported function list.$filteris now validated before it is sent. Unknown fields, non-text columns, and unsupported functions are rejected with a message the model can act on rather than an opaque400. Values containing a single quote are refused outright â the API has no escape form for them.Federated assets degrade gracefully â an asset whose lineage includes non-replicated sources supports only
eq/and/or/(); that failure is now mapped to a message suggesting an equality retry.See
CHANGELOG_v1.6.0.mdfor the full tenant-probe results.
đ What's New (v1.3.0 â lean tool profile)
Leaner agent-facing tool surface â the server now advertises 39 tools by default (down from 49) by hiding redundant/overlapping metadata-discovery tools and developer diagnostics. Tool handlers are unchanged; only what's advertised to the MCP client is filtered, which improves LLM tool-selection accuracy. Controlled by two env vars:
DATASPHERE_TOOL_PROFILEâlean(default) orfull(advertise everything)DATASPHERE_EXPOSE_DIAGNOSTICSâfalse(default) ortrue(advertise thetest_phase*diagnostic tools)
đ What's New (v1.2.1 â wave 2026.10)
get_asset_variablestool â surfaces input parameters/variables and filter capability annotations declared in OData$metadata. Use it to discover what variables a parameterised view or analytic model expects before querying.Variables & filters parsing â
parse_odata_metadata_xml_fullreturns{columns, variables, filters}in one call; the legacyparse_odata_metadata_xmlis preserved as a back-compat wrapper.Aligns with SAP Datasphere wave 2026.10 (May 6, 2026). All calls use the current
/api/v1/datasphere/consumption/...path; the supersededdwcform was removed from the codebase in v1.6.0.
đ Quick Start
Option 1: Install via npm (Recommended for Node.js/Claude Desktop)
# Install globally
npm install -g @mariodefe/sap-datasphere-mcp
# Run the server
npx @mariodefe/sap-datasphere-mcpOption 2: Install via PyPI (Python)
# Install from PyPI
pip install sap-datasphere-mcp
# Run the server
sap-datasphere-mcpSee Getting Started Guide for complete setup instructions.
⨠What's New in v1.5.0
𩹠OData V4 annotation parsing for consumption $metadata â Datasphere's consumption APIs return OData 4.0, where semantic info (Common.Label, Analytics.Dimension, Analytics.measure, units, hierarchies) lives in <Annotation Term="âĻ"> elements rather than legacy sap:* attributes. The metadata tools now read both forms, restoring previously-empty label, dimensions, and measures on get_relational_metadata / get_analytical_metadata / get_analytical_model. The V2 attribute path is kept as a fallback for older sources. See CHANGELOG_v1.5.0.md.
What's New in v1.4.0
đ Config-driven PII / Sensitive-Field Masking â a fail-closed masking layer now runs inside the MCP response pipeline. Sensitive columns are redacted, dropped, hashed, or tokenised before the data ever reaches the LLM, based on a YAML/JSON policy file you control. No prompt can bypass it.
Highlights
â
DATASPHERE_PII_POLICYâ point at a YAML or JSON policy file to activate masking; leave it unset for zero behaviour change.â Five masking actions â
redact(***),drop(column removed),hash(SHA-256, deterministic â safe for GROUP BY),partial:N(keep last N chars),tokenize(stableTKN_xxxxsurrogate).â Fail-closed â if the policy file is configured but can't be parsed, the server refuses to start. It never silently falls back to serving raw data.
â Allowlist mode â lock an asset to an explicit column whitelist; everything else is dropped before column rules even run.
â Value-pattern scanning â secondary regex net catches PII in free-text columns (email, IBAN, SSN, phone) with no explicit column rule required.
â Audit log â every tool call emits a structured log line with
space,asset,masked_fields, andmodeâ SIEM / EU-AI-Act ready. Raw values are never logged.â
audit_onlymode â log what would be masked without changing the data; use during policy rollout to validate coverage before enforcing.â Hooked into all 5 data tools â
smart_query,query_relational_entity,query_analytical_data,get_space_assets,analyze_column_distribution.
⨠What's New in v1.1.0
đ Streamable HTTP Transport â the server now speaks MCP over HTTP as well as stdio, so you can run it as a long-lived service (Docker, ECS, App Runner, behind a reverse proxy) and point multiple clients at the same instance.
Highlights
â New
--transport httpflag â serves MCP Streamable HTTP (spec 2025-03-26) at/mcp, replacing the legacy SSE dual-endpoint dance with a single HTTP route.â Backward compatible â
stdiois still the default; existing Claude Desktop / Claude Code configs keep working with zero changes.â Optional bearer-token auth â enable via
--auth-tokenorMCP_HTTP_AUTH_TOKEN. The server warns if bound to a non-loopback interface without one.â
/healthendpoint â plain JSON liveness probe for load balancers and uptime checks.â Fixed async entry point â new
main_sync()wrapsasyncio.run(main())so the console script works reliably on macOS and Linux.
Usage
# stdio (default, unchanged)
sap-datasphere-mcp
# Streamable HTTP on http://127.0.0.1:8080/mcp
sap-datasphere-mcp --transport http --port 8080
# Exposed on LAN with bearer-token auth
MCP_HTTP_AUTH_TOKEN=$(openssl rand -hex 32) \
sap-datasphere-mcp --transport http --host 0.0.0.0 --port 8080
# Via env vars only (great for Docker / ECS)
MCP_TRANSPORT=http MCP_HTTP_PORT=8080 \
MCP_HTTP_AUTH_TOKEN=$MY_TOKEN \
sap-datasphere-mcpInstall with HTTP extras
pip install 'sap-datasphere-mcp[http]' # adds starlette + uvicorn
# or
uv tool install 'sap-datasphere-mcp[http]' --python 3.12Client call example
curl -N -X POST http://127.0.0.1:8080/mcp/ \
-H "Content-Type: application/json" \
-H "Accept: application/json, text/event-stream" \
-d '{"jsonrpc":"2.0","id":1,"method":"initialize",
"params":{"protocolVersion":"2025-03-26",
"capabilities":{},
"clientInfo":{"name":"curl","version":"0"}}}'CLI / env reference
Flag | Env var | Default | Purpose |
|
|
|
|
|
|
| Bind address in HTTP mode |
|
|
| Bind port in HTTP mode |
|
|
| URL path for the MCP endpoint |
|
| (none) | Require |
See PR #31 for implementation details.
⨠What's New in v1.0.9
Enhanced Aggregation & Improved Logging - Production-ready smart query enhancements:
v1.0.9 - Smart Query Enhancements:
â Simple Aggregation Support - Queries like
SELECT COUNT(*) FROM tablenow work correctlySupport for aggregations without GROUP BY (returns single row)
Enhanced regex to handle ORDER BY in GROUP BY queries
Both simple and grouped aggregations fully supported
â Enhanced Asset Detection - Multi-strategy search reduces false warnings
Exact name match + contains match for case-insensitive searches
Graceful fallback for catalog API limitations
Better handling of schema-prefixed views
â Improved Logging - Better user experience with clearer messages
Info emoji (âšī¸) instead of warning emoji (â ī¸) for non-critical messages
More accurate descriptions ("not in catalog search" vs "not found")
Actionable suggestions only when queries likely to fail
v1.0.8 - Critical Hotfix:
â Fixed aggregation fallback bug - Client-side aggregation now works in both primary and fallback paths
v1.0.7 - Smart Query Production Enhancements:
â Client-side aggregation for GROUP BY queries
â Asset capability detection
â Fuzzy table name matching
â LIMIT pushdown optimization
Result: 39 tools advertised by default (49 with diagnostics enabled) with a production-ready smart query engine supporting all SQL patterns
See CHANGELOG_v1.0.9.md for complete details.
đ Current Status
đ 45 TOOLS AVAILABLE - 44 with real data (98%) | Phases 1-5.1 Complete + Smart Query Engine
â Real data integration - all non-diagnostic tools read live tenant data
â OAuth 2.0 Authentication - Enterprise-grade security with automatic token refresh
â 100% Foundation Tools - All authentication, connection, and user tools working perfectly
â 100% Catalog Tools - Complete asset discovery and metadata exploration
â 100% Search Tools - Client-side search workarounds for catalog and repository
â 100% Database User Management - All 5 tools using real SAP Datasphere CLI
â 100% ETL Tools - All 4 Phase 5.1 tools with enterprise-grade data extraction (up to 50K records)
â NEW: Data Lineage & Quality - Column search and distribution analysis tools
đĄ 1 diagnostic tool - Endpoint testing utility (intentionally mock mode)
đ Complete Documentation
New! Comprehensive production-ready documentation:
Guide | Description | Time to Read |
10-minute quick start with examples | 10 min | |
đ Tools Catalog | Complete reference for all 44 tools | 30 min |
đ§ API Reference | Technical API docs with Python/cURL examples | 45 min |
đ Deployment Guide | Production deployment (Docker, K8s, PyPI) | 20 min |
đ Troubleshooting | Common issues and solutions | 15 min |
Quick Links:
đ What's New - Latest features and improvements
⥠Quick Start - Get running in 5 minutes
đ Query Examples - What data you can query and how
đ ī¸ All Tools - Complete tool list
đ Security - OAuth 2.0 and authorization
đ Query Examples & Available Data
The server provides access to 37+ data assets including sales, products, HR, financial, and time dimension data. See QUERY_EXAMPLES.md for complete examples and documentation.
Available Data Assets
Sales Data: Detailed orders and analytics (All For Bikes, eBike 100, etc.)
Product Catalog: Forklifts ($7,900), Bikes ($288-$699), specifications
HR Analytics: Headcount, job classifications, locations
Financial Data: Transaction details and GL accounts
Time Dimensions: Calendar data from 1900-present
Quick Examples
Sales orders (Relational):
query_relational_entity(
space_id="SAP_CONTENT",
asset_id="SAP_SC_SALES_V_SalesOrders",
entity_name="SAP_SC_SALES_V_SalesOrders",
select="SALESORDERID,COMPANYNAME,GROSSAMOUNT,CURRENCY",
top=5
)Product information (Relational):
query_relational_entity(
space_id="SAP_CONTENT",
asset_id="SAP_SC_FI_V_ProductsDim",
entity_name="SAP_SC_FI_V_ProductsDim",
select="PRODUCTID,MEDIUM_DESCR,PRICE,CURRENCY",
top=5
)Sales analytics (Analytical):
query_analytical_data(
space_id="SAP_CONTENT",
asset_id="SAP_SC_SALES_AM_SalesOrders",
entity_set="SAP_SC_SALES_AM_SalesOrders",
select="COMPANYNAME,GROSSAMOUNT",
orderby="GROSSAMOUNT desc",
top=8
)Performance: 1-5 second response times, up to 50K records per batch.
See QUERY_EXAMPLES.md for 37+ data assets, 5 detailed examples, and best practices.
đ Key Highlights
đ¯ 45 MCP Tools: Comprehensive SAP Datasphere operations via Model Context Protocol
đ OAuth 2.0: Production-ready authentication with automatic token refresh
đ Built-in PII Masking: Config-driven, fail-closed masking layer â sensitive fields never reach the LLM
â Real Data Access: 44 tools (98%) accessing actual tenant data - spaces, assets, users, metadata
đ API Integration: 44 tools (98%) with real data integration via API and CLI
đ§ Smart Query Engine: Production-ready SQL support with client-side aggregation for all query types
đ Asset Discovery: 36+ real assets discovered (HR, Finance, Sales, Time dimensions)
đ Data Querying: Execute OData queries and ETL extraction through natural language on real data
đ§Ŧ Data Lineage: Find assets by column name for impact analysis and lineage tracking
đ Data Quality: Statistical column analysis with null rates, percentiles, and outlier detection
đĨ User Management: Create, update, and manage database users with real API
đ§ AI Integration: Claude Desktop, Cursor IDE, and other MCP-compatible assistants
đ 100% Foundation & Catalog Tools: All core discovery tools fully functional
đĻ Production Ready: Docker, Kubernetes, PyPI + npm packaging available
đ ī¸ Complete Tool Catalog (39 advertised by default, 49 with diagnostics)
đ Real Data Success Summary
Category | Total Tools | Real Data | Success Rate |
Foundation Tools | 5 | 5 â | 100% |
Catalog Tools | 4 | 4 â | 100% |
Space Discovery | 3 | 3 â | 100% |
Search Tools | 2 | 2 â | 100% (client-side workarounds) |
Data Discovery & Quality | 2 | 2 â | 100% (v1.0.3 - lineage & profiling) |
Database User Management | 5 | 5 â | 100% (SAP CLI integration) |
Metadata Tools | 4 | 4 â | 100% |
Analytical Consumption Tools | 4 | 4 â | 100% (OData analytical queries) |
Additional Tools | 5 | 5 â | 100% (connections, tasks, marketplace, etc.) |
Relational Query Tool | 1 | 1 â | 100% (SQL to OData conversion) |
Smart Query Engine | 1 | 1 â | 100% (v1.0.9 - all SQL patterns supported) |
ETL-Optimized Relational Tools | 4 | 4 â | 100% (Phase 5.1 - up to 50K records) |
Diagnostic Tools | 3 | 0 đĄ | Mock Mode (endpoint testing utilities) |
Repository Tools (legacy) | 2 | 0 â | 0% (deprecated - use Catalog instead) |
TOTAL | 45 | 44 (98%) | 98% Coverage |
đ Foundation Tools (5 tools) - 100% Real Data â
Tool | Status | Description |
| â Real Data | Test OAuth connection and get health status |
| â Real Data | Get authenticated user information from JWT token |
| â Real Data | Get SAP Datasphere tenant configuration |
| â Real Data | List OAuth2 scopes from token |
| â Real Data | List all accessible spaces (DEVAULT_SPACE, SAP_CONTENT) |
Example queries:
"Test the connection to SAP Datasphere"
"Who am I? Show my user information"
"What tenant am I connected to?"
"What OAuth scopes do I have?"
"List all SAP Datasphere spaces"Real Data Examples:
Real tenant: your-tenant.eu20.hcs.cloud.sap
Real spaces: DEVAULT_SPACE, SAP_CONTENT
Real user info from OAuth JWT token
Real OAuth scopes (typically 3+ scopes)
đ Space Discovery Tools (3 tools) - 100% Real Data â
Tool | Status | Description |
| â Real Data | Get detailed information about a specific space |
| â Real Data | Get column definitions and data types for tables |
| â Real Data | Search for tables and views by keyword (client-side filtering) |
Example queries:
"Show me details about the SAP_CONTENT space"
"Get the schema for FINANCIAL_TRANSACTIONS table"
"Search for tables containing 'customer'"Real Data Examples:
Real space metadata from API
Real table schemas (when tables exist in space)
search_tables uses client-side filtering workaround (API doesn't support OData filters)
đĻ Catalog & Asset Tools (4 tools) - 100% Real Data â
Tool | Status | Description |
| â Real Data | Browse all catalog assets across spaces (36+ assets found!) |
| â Real Data | Get comprehensive asset metadata and schema |
| â Real Data | Retrieve asset by space and name |
| â Real Data | List all assets within a specific space |
Example queries:
"List all catalog assets in the system"
"Get details for asset SAP_SC_FI_AM_FINTRANSACTIONS"
"Show me all assets in the SAP_CONTENT space"
"Get asset by compound key: space=SAP_CONTENT, id=SAP_SC_HR_V_Divisions"Real Assets Discovered (36+ real assets):
HR Assets: SAP_SC_HR_V_Divisions, SAP_SC_HR_V_JobClass, SAP_SC_HR_V_Location, SAP_SC_HR_V_Job
Finance Assets: SAP_SC_FI_V_ProductsDim, SAP_SC_FI_AM_FINTRANSACTIONS
Time & Sales Models: Multiple analytical models with real metadata URLs
All assets include real metadata URLs pointing to your tenant
đ Search Tools (2 tools) - 100% Real Data â
Tool | Status | Description |
| â Real Data | Search catalog assets by query (client-side workaround) |
| â Real Data | Search repository objects with filters (client-side workaround) |
Example queries:
"Search catalog for 'sales'"
"Find repository objects containing 'customer'"
"Search for analytical models in SAP_CONTENT"Real Data Examples:
Client-side search across name, label, businessName, and description fields
Support for facets (objectType, spaceId aggregation)
Support for filters (object_types, space_id)
Support for why_found tracking (shows which fields matched)
Pagination and total_matches reporting
Implementation:
Both tools use client-side search workarounds since /api/v1/datasphere/consumption/catalog/search endpoint returns 404 Not Found. They fetch all assets from /catalog/assets and filter client-side.
đŦ Data Discovery & Quality Tools (2 tools) - 100% Real Data â
Tool | Status | Description |
| â Real Data | Find all assets containing a specific column name for data lineage |
| â Real Data | Statistical analysis of column data distribution and quality profiling |
Example queries:
"Which tables contain CUSTOMER_ID column?"
"Find all assets with SALES_AMOUNT"
"Analyze the distribution of ORDER_TOTAL column"
"What's the data quality of CUSTOMER_AGE field?"
"Profile the PRICE column for outliers"Real Data Examples:
Data Lineage: Cross-space column search, impact analysis before schema changes
Quality Profiling: Null rates, distinct values, percentiles, outlier detection (IQR method)
Use Cases: Data discovery, schema relationship mapping, data quality assessment, pre-analytics profiling
Implementation: Both tools introduced in v1.0.3 provide advanced data discovery and quality capabilities:
find_assets_by_column: Searches across multiple spaces, case-insensitive by default, up to 200 resultsanalyze_column_distribution: Analyzes up to 10,000 records, automatic type detection, percentile analysis
đ Metadata Tools (4 tools) - 100% Real Data â
Tool | Status | Description |
| â Real Data | Retrieve CSDL metadata schema for catalog service |
| â Real Data | Get analytical model metadata with pre-flight checks |
| â Real Data | Get relational schema with SQL type mappings |
| â Real Data | List analytical datasets (fixed query parameters) |
Example queries:
"Get the catalog metadata schema"
"Retrieve analytical metadata for SAP_SC_FI_AM_FINTRANSACTIONS"
"Get relational schema for CUSTOMER_DATA table"
"List analytical datasets"Status: All 4 tools return real data with proper error handling and capability checks.
đĨ Database User Management Tools (5 tools) - 100% Real Data â
Tool | Status | Description | Requires Consent |
| â Real Data | List all database users (SAP CLI) | No |
| â Real Data | Create new database user (SAP CLI) | Yes (ADMIN) |
| â Real Data | Update user permissions (SAP CLI) | Yes (ADMIN) |
| â Real Data | Delete database user (SAP CLI) | Yes (ADMIN) |
| â Real Data | Reset user password (SAP CLI) | Yes (SENSITIVE) |
Example queries:
"List all database users in SAP_CONTENT space"
"Create a new database user named ETL_USER"
"Update permissions for DB_USER_001"
"Delete database user TEST_USER"
"Reset password for DB_USER_001"Status: All 5 tools use real SAP Datasphere CLI integration with subprocess execution, temporary file handling, and comprehensive error handling.
Consent Management: High-risk operations (create, update, delete, reset password) require user consent on first use. Consent is cached for 60 minutes.
đ§ API Syntax Fixes (4 tools) - 100% Real Data â
Tool | Status | Description |
| â Real Data | Search tables/views (client-side filtering) |
| â Real Data | List deployed objects (removed unsupported filters) |
| â Real Data | List datasets (fixed query parameters) |
| â Real Data | Get metadata (pre-flight capability checks) |
Status: All 4 tools fixed during Phase 2 - removed unsupported OData filters and added client-side workarounds.
đ§ HTML Response Fixes (2 tools) - 100% Real Data â
Tool | Status | Description |
| â Real Data | Graceful error handling for HTML responses |
| â Real Data | Professional degradation for UI-only endpoints |
Status: Both tools fixed during Phase 3 - added content-type validation and helpful error messages when endpoints return HTML instead of JSON.
đ Analytical Consumption Tools (4 tools) - 100% Real Data â
Tool | Status | Description |
| â Real Data | Get OData service document and analytical model metadata |
| â Real Data | Get service capabilities, entity sets, and navigation properties |
| â Real Data | List all analytical datasets and entity sets for a model |
| â Real Data | Execute OData analytical queries with $select, $filter, $apply, $top |
Example queries:
"Get analytical model for SAP_SC_FI_AM_FINTRANSACTIONS"
"Show me the service document for SAP_SC_HR_V_Divisions"
"List all datasets in the analytical model"
"Query analytical data from SAP_SC_FI_AM_FINTRANSACTIONS with filters"Real Data Features:
OData v4.0 analytical consumption API (/api/v1/datasphere/consumption/analytical)
Full metadata discovery (service documents, entity sets, properties)
Advanced filtering with $filter, $select, $top, $skip, $orderby
Aggregation support with $apply (groupby, aggregate functions)
Real tenant data from your SAP Datasphere instance
Status: All 4 analytical consumption tools fully operational with real SAP Datasphere data!
đ Additional Tools (5 tools) - 100% Real Data â
Tool | Status | Description |
| â Real Data | List all configured connections (HANA, S/4HANA, etc.) |
| â Real Data | Monitor task execution status and progress |
| â Real Data | Browse Data Marketplace assets and packages |
| â Real Data | Get consumption layer metadata (CSDL schema) |
| â Real Data | List all deployed objects in a space |
Example queries:
"List all connections in the system"
"Check the status of task 12345"
"Browse the Data Marketplace"
"Get consumption metadata schema"
"Show deployed objects in SAP_CONTENT"Status: All additional tools provide essential system management capabilities with full real data support.
đ§Ē Diagnostic Tools (3 tools) - Endpoint Testing Utilities
Tool | Status | Description |
| đ§Ē Diagnostic | Test analytical/query API endpoint availability |
| đ§Ē Diagnostic | Test Phase 6 & 7 endpoint availability (KPI, monitoring, users) |
| đ§Ē Diagnostic | Test Phase 8 endpoint availability (data sharing, AI features) |
Purpose: These diagnostic tools help verify which SAP Datasphere API endpoints are available in your specific tenant configuration. They return structured reports with:
HTTP status codes for each endpoint
Error messages and troubleshooting guidance
Recommendations for workarounds or alternative tools
Status: Diagnostic tools intentionally use mock/test mode to validate endpoint availability without modifying data.
đī¸ Repository Tools (2 tools) - Deprecated (Use Catalog Instead)
Tool | Status | Description |
| â ī¸ Deprecated | List repository objects (use list_catalog_assets instead) |
| â ī¸ Deprecated | Get object definition (use get_asset_details instead) |
Recommendation: These legacy repository tools are deprecated. Use the modern Catalog Tools instead:
Replace
list_repository_objectsâlist_catalog_assetsorsearch_catalogReplace
get_object_definitionâget_asset_details
Status: Catalog Tools provide superior functionality with full real data support.
đ Relational Query Tool (1 tool) - 100% Real Data â
Tool | Status | Description | Requires Consent |
| â Real Data | Execute SQL queries on Datasphere tables/views with SQLâOData conversion | Yes (WRITE) |
Example queries:
"Execute query: SELECT * FROM SAP_SC_FI_AM_FINTRANSACTIONS LIMIT 10"
"Query: SELECT customer_id, amount FROM SALES_ORDERS WHERE status = 'COMPLETED' LIMIT 50"
"Get data: SELECT * FROM SAP_SC_HR_V_Divisions"Real Data Features:
SQL to OData Conversion: Automatically converts SQL queries to OData API calls
Relational Consumption API:
/api/v1/datasphere/consumption/relational/{space_id}/{view_name}Supported SQL Syntax:
SELECT *orSELECT column1, column2â OData$selectWHERE conditionsâ OData$filter(basic conversion)LIMIT Nâ OData$top
Query Safety: Max 1000 rows, 60-second timeout
Error Handling: Helpful messages for table not found, parse errors, permission issues
SQL Conversion Examples:
SELECT * FROM CUSTOMERS WHERE country = 'USA' LIMIT 10
â GET /relational/SPACE/CUSTOMERS?$filter=country eq 'USA'&$top=10
SELECT customer_id, name FROM ORDERS LIMIT 20
â GET /relational/SPACE/ORDERS?$select=customer_id,name&$top=20Limitations:
No JOINs (OData single-table queries only)
Basic WHERE clause conversion (simple comparisons work)
No GROUP BY, ORDER BY (future enhancement)
Table/view names are case-sensitive
Status: â Fully functional with real SAP Datasphere data! Tested and confirmed working.
đ§ Smart Query Engine (1 tool) - 100% Real Data â NEW v1.0.9!
Tool | Status | Description | Requires Consent |
| â Real Data | Intelligent SQL query router with client-side aggregation and multi-tier fallback | No (READ) |
Example queries:
"Query: SELECT * FROM SAP_SC_FI_V_ProductsDim LIMIT 5"
"Get product counts by category: SELECT PRODUCTCATEGORYID, COUNT(*) FROM SAP_SC_FI_V_ProductsDim GROUP BY PRODUCTCATEGORYID"
"Simple aggregation: SELECT COUNT(*), AVG(PRICE) FROM SAP_SC_FI_V_ProductsDim"
"Analytics with sorting: SELECT CATEGORY, COUNT(*), AVG(PRICE) FROM Products GROUP BY CATEGORY ORDER BY COUNT(*) DESC"Real Data Features:
Intelligent Routing: Automatically chooses between analytical and relational endpoints based on query type and asset capabilities
Client-Side Aggregation: Full support for SQL aggregations when API doesn't support them
Simple aggregations:
SELECT COUNT(*) FROM table(returns single row)GROUP BY aggregations:
SELECT category, COUNT(*) FROM table GROUP BY categoryAll aggregate functions: COUNT, SUM, AVG, MIN, MAX
Asset Capability Detection: Multi-strategy search to verify asset support before query execution
Enhanced Error Messages: Fuzzy table name matching with actionable suggestions
LIMIT Pushdown: Automatically converts SQL LIMIT to OData $top for optimal performance
Multi-Tier Fallback: Primary (analytical) â Fallback (relational + aggregation) â Helpful error
Query Types Supported:
-- Simple queries
SELECT * FROM table LIMIT 10
-- Simple aggregations (NEW in v1.0.9)
SELECT COUNT(*) FROM table
SELECT COUNT(*), AVG(price), MAX(price) FROM table
-- GROUP BY aggregations
SELECT category, COUNT(*), AVG(price) FROM table GROUP BY category
-- Complex queries with ORDER BY
SELECT category, COUNT(*) as cnt FROM table GROUP BY category ORDER BY cnt DESC LIMIT 5Performance:
Response Times: 500ms - 2s depending on data volume
Batch Size: Up to 50,000 records per query
Optimization: LIMIT pushdown reduces data transfer by up to 95%
Status: â Production-ready with comprehensive SQL support! All common query patterns working flawlessly (v1.0.7-v1.0.9 enhancements).
đ ETL-Optimized Relational Tools (4 tools) - 100% Real Data â NEW Phase 5.1!
Tool | Status | Description | Requires Consent |
| â Real Data | List all available relational entities (tables/views) within an asset for ETL operations | No (READ) |
| â Real Data | Get entity metadata with SQL type mappings (ODataâSQL) for data warehouse loading | No (READ) |
| â Real Data | Execute OData queries with large batch processing (up to 50,000 records) for ETL extraction | No (READ) |
| â Real Data | Get OData service document with ETL planning capabilities and query optimization guidance | No (READ) |
Example queries:
"List all relational entities in SAP_CONTENT space for asset SAP_SC_SALES_V_Fact_Sales"
"Get entity metadata with SQL types for SAP_CONTENT/SAP_SC_SALES_V_Fact_Sales"
"Query relational entity from SAP_CONTENT, asset SAP_SC_SALES_V_Fact_Sales, entity Results, limit 1000"
"Get OData service document for SAP_CONTENT/SAP_SC_SALES_V_Fact_Sales with ETL capabilities"Real Data Features:
Large Batch Processing: Extract up to 50,000 records per query (vs 1,000 for execute_query)
SQL Type Mapping: Automatic OData to SQL type conversion (NVARCHAR, BIGINT, DECIMAL, DATE, etc.)
ETL Planning: Service discovery, entity enumeration, batch size recommendations
Performance Optimization: Incremental extraction, parallel loading, pagination strategies
Production Quality: Sub-second response times with real production data
ETL Use Cases:
Data Warehouse Loading: Extract large datasets with proper SQL types for target databases
Incremental Extraction: Use
$filterwith date columns for delta loadsParallel Extraction: Use
$skipwith multiple concurrent requests for high-volume dataSchema Discovery: Get complete metadata with column types, precision, scale before ETL jobs
Advanced Query Capabilities:
OData Parameters Supported:
- $filter: Complex filtering expressions (e.g., "amount gt 1000 and status eq 'ACTIVE'")
- $select: Column projection (e.g., "customer_id,amount,date")
- $top/$skip: Pagination (up to 50K per batch)
- $orderby: Sorting (e.g., "amount desc, date asc")SQL Type Mapping Examples:
Edm.String â NVARCHAR(MAX)
Edm.Int32 â INT
Edm.Int64 â BIGINT
Edm.Decimal â DECIMAL(18,2)
Edm.Double â DOUBLE
Edm.Date â DATE
Edm.DateTime â TIMESTAMP
Edm.Boolean â BOOLEANEndpoint Pattern:
GET /api/v1/datasphere/consumption/relational/{space}/{asset} â List entities
GET /api/v1/datasphere/consumption/relational/{space}/{asset}/$metadata â Get metadata
GET /api/v1/datasphere/consumption/relational/{space}/{asset}/{entity} â Query dataStatus: â All 4 tools fully functional with enterprise-grade ETL capabilities! Tested with real production sales data, achieving sub-second performance with large result sets.
đ Quick Start
Prerequisites
Python 3.10+
SAP Datasphere account with OAuth 2.0 configured
Technical User with appropriate permissionsInstallation
# 1. Clone the repository
git clone https://github.com/MarioDeFelipe/sap-datasphere-mcp.git
cd sap-datasphere-mcp
# 2. Install dependencies
pip install -r requirements.txt
# 3. Configure OAuth credentials
cp .env.example .env
# Edit .env with your SAP Datasphere OAuth credentials
# 4. Start MCP Server
python sap_datasphere_mcp_server.pyConfiguration
Create a .env file with your SAP Datasphere credentials:
# SAP Datasphere Connection
DATASPHERE_BASE_URL=https://your-tenant.eu10.hcs.cloud.sap
DATASPHERE_TENANT_ID=your-tenant-id
# OAuth 2.0 Credentials (Technical User)
DATASPHERE_CLIENT_ID=your-client-id
DATASPHERE_CLIENT_SECRET=your-client-secret
DATASPHERE_TOKEN_URL=https://your-tenant.authentication.eu10.hana.ondemand.com/oauth/token
# Optional: Mock Data Mode (for testing without real credentials)
USE_MOCK_DATA=falseâ ī¸ Important: Never commit your .env file to version control!
đ Need help with OAuth setup? See the complete guide: OAuth Setup Guide
đ¤ AI Assistant Integration
Claude Desktop
Option 1: Using npm (Recommended)
Add to your claude_desktop_config.json:
{
"mcpServers": {
"sap-datasphere": {
"command": "npx",
"args": ["@mariodefe/sap-datasphere-mcp"],
"env": {
"DATASPHERE_BASE_URL": "https://your-tenant.eu20.hcs.cloud.sap",
"DATASPHERE_CLIENT_ID": "your-client-id",
"DATASPHERE_CLIENT_SECRET": "your-client-secret",
"DATASPHERE_TOKEN_URL": "https://your-tenant.authentication.eu20.hana.ondemand.com/oauth/token"
}
}
}
}Option 2: Using Python directly
{
"mcpServers": {
"sap-datasphere": {
"command": "python",
"args": ["-m", "sap_datasphere_mcp_server"],
"env": {
"DATASPHERE_BASE_URL": "https://your-tenant.eu20.hcs.cloud.sap",
"DATASPHERE_CLIENT_ID": "your-client-id",
"DATASPHERE_CLIENT_SECRET": "your-client-secret",
"DATASPHERE_TOKEN_URL": "https://your-tenant.authentication.eu20.hana.ondemand.com/oauth/token"
}
}
}
}Location:
Windows:
%APPDATA%\Claude\claude_desktop_config.jsonmacOS:
~/Library/Application Support/Claude/claude_desktop_config.jsonLinux:
~/.config/Claude/claude_desktop_config.json
Example Natural Language Queries
Once configured, ask your AI assistant:
Space & Discovery:
"List all SAP Datasphere spaces"
"Show me the schema for the CUSTOMERS table"
"Search for tables containing 'sales' in SAP_CONTENT"Metadata Exploration:
"Get the analytical metadata for REVENUE_ANALYSIS"
"Show me the catalog metadata schema"
"Get relational schema for FINANCIAL_TRANSACTIONS"Analytical Queries:
"Query financial data where Amount > 1000"
"Get analytical model for SALES_ANALYTICS.REVENUE_ANALYSIS"
"Execute aggregation: group by Currency and sum Amount"User Management:
"List all database users"
"Create a new database user named ETL_READER"
"Update permissions for user DB_USER_001"Repository Objects:
"Get the complete definition for SAP_SC_FI_AM_FINTRANSACTIONS"
"Show me all assets in SAP_CONTENT space"
"Get repository search metadata"đ Security Features
OAuth 2.0 Authentication
â Client Credentials Flow: Secure Technical User authentication
â Automatic Token Refresh: Tokens refreshed 60 seconds before expiration
â Encrypted Storage: Tokens encrypted in memory using Fernet encryption
â No Credentials in Code: All secrets loaded from environment variables
â Retry Logic: Exponential backoff for transient failures
Authorization & Consent
â Permission Levels: READ, WRITE, ADMIN, SENSITIVE
â User Consent: Interactive prompts for high-risk operations
â Audit Logging: Complete operation audit trails
â Input Validation: SQL injection prevention with 15+ attack patterns
â Data Filtering: Automatic PII and credential redaction
Security Best Practices
đ Environment-based Configuration: No hardcoded credentials
đ HTTPS/TLS: All communications encrypted
đ Comprehensive Logging: Detailed security audit trails
đ Token Management: Automatic refresh and secure rotation
đĄī¸ SQL Sanitization: Read-only queries, injection prevention
đ PII / Sensitive-Field Masking
The server ships a config-driven, fail-closed PII masking layer that runs
inside the MCP response pipeline. Every data-returning tool
(smart_query, query_relational_entity, query_analytical_data,
get_space_assets, analyze_column_distribution) funnels results through
apply_masking() before the data reaches the LLM client.
Defense-in-depth note. The authoritative access control remains upstream (SAP Datasphere Data Access Controls / not granting the technical user access to PII tables). This layer is the enforced, auditable net on top â no prompt can bypass it.
Configuration
Environment Variable | Values | Default | Purpose |
| path to YAML or JSON | (unset) | Policy file path. When unset masking is fully disabled â backwards-compatible default. |
|
|
|
|
| secret string | (empty) | Salt for deterministic |
# .env
DATASPHERE_PII_POLICY=/etc/datasphere/pii_policy.yaml
DATASPHERE_PII_MODE=enforce
DATASPHERE_PII_SALT=my-very-secret-saltFail-closed behaviour
If DATASPHERE_PII_POLICY is set but the file is missing or unparseable,
the server raises a RuntimeError at startup and refuses to start. It never
silently falls back to serving raw data with a broken policy.
Policy file schema
See the bundled pii_policy.yaml for a full annotated
example. Key concepts:
mode: enforce # overridden by DATASPHERE_PII_MODE if set
default_action: redact # applied to value-pattern matches and unknown actions
rules:
# Most-specific match wins: asset-level > space-level > global > glob pattern
- space: ZDCS_08
asset: ZR_SAP_CUSTOMER
columns:
EMAIL: redact # â "***"
PHONE: partial:4 # keep last 4 chars â "******1234"
TAXID: hash # sha256(salt:value) â deterministic, supports grouping
SSN: drop # column removed from every returned row entirely
- space: "*" # applies to every space
columns:
"*IBAN*": tokenize # glob match on column name â "TKN_<8hex>"
allowlist:
enabled: true
assets:
ZDCS_08.ZR_OTC_CUST_MONTH: [CUSTOMER, MONTH, REVENUE] # ONLY these cols returned
patterns:
email: '[A-Za-z0-9._%+\-]+@[A-Za-z0-9.\-]+\.[A-Za-z]{2,}'
iban: '\b[A-Z]{2}\d{2}[A-Z0-9]{10,30}\b'Masking actions
Action | Result | Deterministic? |
|
| N/A |
| column removed from row | N/A |
|
| â â safe for GROUP BY / JOIN |
| last N chars kept, rest replaced with | N/A |
|
| â |
Precedence
Allowlist (strongest): if enabled for an asset, all non-listed columns are dropped before rules run.
Column rules: most-specific match wins (asset > space > global; exact > glob).
Value patterns: scanned on remaining string values; match â
default_action.
Audit log
Every tool call emits a structured log line at INFO level:
[pii_masking] space=ZDCS_08 asset=ZR_SAP_CUSTOMER rows=42
masked_fields=['EMAIL', 'PHONE', 'SSN'] mode=enforceRaw masked values are never logged. This provides SIEM / EU-AI-Act evidence that masking fired on every call.
The MCP response also includes a masked_fields key listing which columns were
touched, so the LLM client can see what was withheld.
đ Architecture
System Architecture
âââââââââââââââââââ ââââââââââââââââââââ âââââââââââââââââââ
â AI Assistant âââââēâ MCP Server âââââēâ SAP Datasphere â
â (Claude, Cursor)â â 32 Tools â â (OAuth 2.0) â
â â â Authorization â â â
â â â Caching â â â
â â â Telemetry â â â
âââââââââââââââââââ ââââââââââââââââââââ âââââââââââââââââââCore Components
Authentication Layer:
auth/oauth_handler.py- Token management and refreshauth/datasphere_auth_connector.py- Authenticated API connectorauth/authorization.py- Permission-based authorizationauth/consent_manager.py- User consent tracking
Security Layer:
auth/input_validator.py- Input validation frameworkauth/sql_sanitizer.py- SQL injection preventionauth/data_filter.py- PII and credential redaction
Performance Layer:
cache_manager.py- Intelligent caching with TTLtelemetry.py- Request tracking and metrics
MCP Server:
sap_datasphere_mcp_server.py- Main server (39 tools advertised, 49 with diagnostics)
đ Production Deployment
Quick Deployment Options
Docker (Recommended):
# Build and run
docker build -t sap-datasphere-mcp:latest .
docker run -d --name sap-mcp --env-file .env sap-datasphere-mcp:latest
# Using Docker Compose
docker-compose up -dPyPI Package (Coming Soon):
pip install sap-datasphere-mcp
sap-datasphere-mcpKubernetes:
# Create secrets
kubectl create secret generic sap-mcp-secrets \
--from-literal=DATASPHERE_CLIENT_ID='...' \
--from-literal=DATASPHERE_CLIENT_SECRET='...'
# Deploy
kubectl apply -f k8s/deployment.yaml
kubectl scale deployment sap-mcp-server --replicas=5Manual:
git clone https://github.com/MarioDeFelipe/sap-datasphere-mcp.git
cd sap-datasphere-mcp
pip install -r requirements.txt
cp .env.example .env # Edit with your credentials
python sap_datasphere_mcp_server.pyđ See DEPLOYMENT.md for complete production deployment guide
đ Performance Characteristics
Response Times
⥠Metadata Queries: Sub-100ms (cached)
⥠Catalog Queries: 100-500ms
⥠OData Queries: 500-2000ms (depends on data volume)
⥠Token Refresh: Automatic, transparent to user
Caching Strategy
đ Spaces: 1 hour TTL
đĻ Assets: 30 minutes TTL
đ Metadata: 15 minutes TTL
đĨ Users: 5 minutes TTL
đ LRU Eviction: Automatic cleanup of old entries
Scalability
đ Concurrent Requests: Multiple simultaneous MCP operations
đĄī¸ Error Recovery: Automatic retry with exponential backoff
đ Connection Pooling: Efficient resource management
đ§Ē Testing
Run Tests
# Test MCP server startup
python test_mcp_server_startup.py
# Test authorization coverage
python test_authorization_coverage.py
# Test input validation
python test_validation.py
# Test with MCP Inspector
npx @modelcontextprotocol/inspector python sap_datasphere_mcp_server.pyTest Results
Current suite: run pytest for the live number. The counts below are a
point-in-time record from the v1.0.x era and are kept for history only.
â 42/42 tools registered (as of v1.0.9) - All tools properly defined
â 42/42 tools authorized (as of v1.0.9) - Authorization permissions configured
â 41/42 tools working (as of v1.0.9) - 98% success rate
đ Project Structure
sap-datasphere-mcp/
âââ đ auth/ # Authentication & Security
â âââ oauth_handler.py # OAuth 2.0 token management
â âââ datasphere_auth_connector.py # Authenticated API connector
â âââ authorization.py # Permission-based authorization
â âââ consent_manager.py # User consent tracking
â âââ input_validator.py # Input validation framework
â âââ sql_sanitizer.py # SQL injection prevention
â âââ data_filter.py # PII and credential redaction
âââ đ config/ # Configuration management
â âââ settings.py # Environment-based settings
âââ đ docs/ # Documentation
â âââ OAUTH_SETUP.md # OAuth setup guide
â âââ TROUBLESHOOTING_CLAUDE_DESKTOP.md
â âââ OAUTH_IMPLEMENTATION_STATUS.md
âââ đ sap_datasphere_mcp_server.py # Main MCP server (39 lean / 49 full)
âââ đ odata_v4_annotations.py # OData V4 CSDL annotation reader (V2 fallback)
âââ đ odata_filter.py # $filter parsing, validation, capability gating
âââ đ asset_capability.py # Per-asset countability / filter profile
âââ đ pii_masking.py # Config-driven PII masking (fail-closed)
âââ đ error_helpers.py # Actionable error construction
âââ đ tool_descriptions.py # Tool text and visibility profiles
âââ đ cache_manager.py # Intelligent caching
âââ đ telemetry.py # Monitoring and metrics
âââ đ mock_data.py # Mock data for testing
âââ đ pii_policy.yaml # Masking policy (editable)
âââ đ .env.example # Configuration template
âââ đ requirements.txt # Python dependencies
âââ đ README.md # This file
âââ đ ULTIMATE_TEST_RESULTS.md # Comprehensive test resultsđ Acknowledgments
This MCP server was built with significant contributions from:
Amazon Kiro
Provided comprehensive specifications, architectural steering, and development guidance that shaped the MCP server's design and implementation.
Claude Code
AI-powered development assistant that contributed to:
Phase 1: Security & Authentication
OAuth 2.0 implementation with automatic token refresh
Permission-based authorization (READ, WRITE, ADMIN, SENSITIVE)
User consent flows for high-risk operations
Input validation and SQL sanitization
Sensitive data filtering and PII redaction
Phase 2: UX & AI Interaction
Enhanced tool descriptions with examples
Intelligent error messages with recovery suggestions
Parameter validation with clear format requirements
Phase 3: Performance & Monitoring
Intelligent caching with category-based TTL
Comprehensive telemetry and metrics
Performance optimization (up to 95% faster for cached queries)
Phase 4: Repository & Analytics
Repository object discovery tools
Analytical model access and OData query support
Metadata extraction and schema discovery
Mock Data Remediation Journey:
Phase 1: Database User Management (5/5 tools) - SAP CLI integration â
Phase 2: API Syntax Fixes (4/4 tools) - OData filter workarounds â
Phase 3: HTML Response Fixes (2/2 tools) - Graceful degradation â
Phase 4: Search Workarounds (2/2 tools) - Client-side search â
Achievement: From 42.9% â 80% real data integration! đ¯
đ License
This project is licensed under the MIT License - see the LICENSE file for details.
đ Support
đ Documentation: See
/docsfolder for detailed guidesđ Issues: GitHub Issues
đŦ Discussions: GitHub Discussions
đ SAP Datasphere: Official Documentation
đ¤ MCP Protocol: Model Context Protocol
đ¯ Roadmap
Completed â
OAuth 2.0 authentication with automatic token refresh
35 MCP tools implementation
đ¯ TARGET ACHIEVED: 80% real data integration (28/35 tools)
Authorization and consent management
Input validation and SQL sanitization
Intelligent caching and telemetry
Phase 1: Database User Management (5/5 tools) - SAP CLI integration
Phase 2: API Syntax Fixes (4/4 tools) - OData filter workarounds
Phase 3: HTML Response Fixes (2/2 tools) - Graceful degradation
Phase 4: Search Workarounds (2/2 tools) - Client-side search
Comprehensive testing with real SAP Datasphere tenant
36+ real assets discovered (HR, Finance, Sales, Time dimensions)
100% Foundation, Catalog, Search, Metadata & User Management Tools
Future Enhancements đŽ
Analytical tools real data integration (requires tenant configuration)
Enhanced query execution capabilities
Additional permission scopes for restricted endpoints
Vector database integration for semantic search
Real-time event streaming
Advanced schema visualization
Multi-tenant support
Machine learning integration
đ Production-Ready SAP Datasphere MCP Server
đ¯ TARGET ACHIEVED: 28/35 Tools with Real Data (80%)
36+ Real Assets Discovered | All Critical Tools Working
Built with â¤ī¸ for AI-powered enterprise data integration
From 42.9% â 80% real data integration through systematic mock data remediation!
Available Tools
39 toolsanalyze_column_distributionA
Perform advanced statistical analysis of a column's data distribution including nulls, distinct values, percentiles, and outlier detection.
Use this tool when:
User asks "What's the data quality of AMOUNT column?"
Performing data profiling before analytics
Assessing column completeness and distribution
Detecting outliers and data anomalies
Understanding data patterns for ML/AI
What you'll get:
Basic statistics (count, nulls, distinct values, completeness)
Numeric statistics (min, max, mean, percentiles)
Distribution analysis (top values, frequency)
Outlier detection (IQR method)
Data quality assessment
Use cases:
Data quality assessment
Pre-analytics data profiling
Outlier and anomaly detection
Understanding value distributions
ML feature engineering preparation
Data cleansing planning
Example queries:
"Analyze the distribution of SALES_AMOUNT column"
"What's the data quality of CUSTOMER_AGE?"
"Profile the ORDER_STATUS column"
"Detect outliers in PRICE column"
"Show me statistics for QUANTITY field"
Analysis includes:
Null percentage and completeness rate
Distinct value count and cardinality
For numeric columns: min, max, mean, percentiles (p25, p50, p75)
Top value frequencies
Outlier detection using IQR method
Data quality recommendations
Performance notes:
Analyzes up to 10,000 records (configurable)
Default sample size: 1,000 records
Works with numeric, string, and date columns
Automatic type detection and appropriate statistics
| Name | Required | Description | Default |
|---|---|---|---|
| space_id | Yes | Space ID containing the asset (e.g., 'SAP_CONTENT', 'SALES_ANALYTICS') | |
| asset_name | Yes | Asset (table/view) name containing the column | |
| column_name | Yes | Column name to analyze (e.g., 'SALES_AMOUNT', 'CUSTOMER_AGE', 'ORDER_STATUS') | |
| sample_size | No | Optional: Number of records to analyze (10-10000). Default: 1000. Larger samples = more accurate but slower. | |
| include_outliers | No | Optional: Detect and report outliers using IQR method. Default: true |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description discloses key behaviors: max 10,000 records, default sample size 1000, works with numeric/string/date columns, automatic type detection, and specific statistics computed (percentiles, IQR). It omits permission requirements or side effects, but for a read-only analysis tool, this is sufficient.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with sections and front-loaded with purpose, but it is verbose and contains some repetition (e.g., 'data quality' appears multiple times). Could be more concise without losing clarity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given 5 parameters, no output schema, and no annotations, the description covers purpose, parameter details, use cases, performance notes, and expected output statistics. It fully enables an agent to select and invoke the tool correctly without needing external context.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so baseline is 3. The description adds marginal value by explaining sample_size trade-offs and default values, but these are already in the schema. Additional context like use cases does not directly enhance parameter understanding.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool performs advanced statistical analysis of a column's data distribution, including nulls, distinct values, percentiles, and outlier detection. It distinguishes itself from sibling tools like get_table_schema or find_assets_by_column by focusing on distribution analysis rather than metadata or search.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit when-to-use scenarios (e.g., data quality checks, profiling, outlier detection) and example queries. However, it does not explicitly state when not to use this tool or contrast with alternatives like querying directly, but the context is clear.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
browse_marketplaceA
Browse and search available data packages in the SAP Datasphere marketplace.
Use this tool when:
User asks "What data packages are available?"
Looking for external reference data (benchmarks, currency rates, etc.)
Exploring marketplace offerings
Planning to enrich internal data with external sources
What you'll get:
Package IDs and names
Package descriptions and categories
Provider information
Package versions and sizes
Pricing information (Free or paid)
Categories:
Reference Data (industry benchmarks, standards)
Financial Data (currency rates, market data)
Geospatial Data
Industry-specific datasets
Example queries:
"What marketplace packages are available?"
"Find financial data packages"
"Show me industry benchmarks"
"Search for currency rate data"
Use cases:
Data enrichment planning
Finding external reference data
Competitive benchmarking
Currency conversion support
| Name | Required | Description | Default |
|---|---|---|---|
| category | No | Optional: Filter by category (e.g., 'Reference Data', 'Financial Data'). Leave empty to browse all. | |
| search_term | No | Optional: Search keyword for package names or descriptions (e.g., 'currency', 'benchmark'). Case-insensitive. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries full burden. It discloses what the tool returns (package IDs, names, categories, provider, versions, sizes, pricing) and lists categories and use cases. Missing details on pagination, rate limits, or result format (e.g., list), but adequate for a browse tool.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Well-structured with sections (when to use, what you get, categories, examples, use cases). Concise enough, though slightly verbose. Information is front-loaded with purpose and usage guidelines.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no annotations and no output schema, the description provides thorough information about output contents and categories. Missing return type (e.g., list) and error handling, but sufficient for effective use.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% as descriptions are provided for both parameters. The description adds context beyond schema: category filter and case-insensitive search, with examples. Provides meaningful guidance for parameter usage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states that the tool browses and searches available data packages in the SAP Datasphere marketplace, with specific verb 'browse and search' and resource 'data packages'. It distinguishes from siblings as no other sibling tool covers marketplace browsing.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicit when-to-use scenarios are listed (e.g., 'User asks what packages are available'), including example queries and use cases. However, it does not mention when not to use or specific alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
create_database_userA
Create a new database user in a SAP Datasphere space with specified permissions.
IMPORTANT: This is a HIGH-RISK tool that requires user consent before execution.
Use this tool when:
User requests "Create a database user named JEFF in SALES"
Setting up new user access for applications or analysts
Configuring data ingestion users
Establishing read-only consumption users
Required parameters:
space_id: The space where user will be created
database_user_id: User name suffix (e.g., 'JEFF', 'REPORTING_USER')
user_definition: JSON object defining permissions and settings
User definition structure:
{
"consumption": {
"consumptionWithGrant": false,
"spaceSchemaAccess": false,
"scriptServerAccess": false,
"enablePasswordPolicy": false,
"localSchemaAccess": false,
"hdiGrantorForCupsAccess": false
},
"ingestion": {
"auditing": {
"dppRead": {
"isAuditPolicyActive": false,
"retentionPeriod": 7
},
"dppChange": {
"isAuditPolicyActive": false,
"retentionPeriod": 7
}
}
}
}Permission types:
Consumption: Read access to space data
consumptionWithGrant: Allow granting privileges to others
spaceSchemaAccess: Access to space schema objects
scriptServerAccess: Execute stored procedures/UDFs
Ingestion: Write access for data loading
Audit policies for compliance (DPP read/change tracking)
Security notes:
New password is auto-generated and returned (store securely!)
Audit retention period: 1-365 days
Minimum privilege principle recommended
Password must be changed on first login
Example queries:
"Create a read-only database user named ANALYST in SALES"
"Set up a database user for data loading in FINANCE"
"Create user REPORTING with consumption access"
Note: Corresponds to CLI: datasphere dbusers create --space --databaseuser --file-path <def.json>
| Name | Required | Description | Default |
|---|---|---|---|
| space_id | Yes | The space ID where user will be created (e.g., 'SALES', 'FINANCE'). Must be uppercase. | |
| output_file | No | Optional: Path to save user credentials JSON (e.g., 'jeff.json'). RECOMMENDED for security - credentials shown only once! | |
| user_definition | Yes | JSON object defining user permissions and settings. Must include 'consumption' and 'ingestion' sections. | |
| database_user_id | Yes | Database user name suffix (e.g., 'JEFF', 'ANALYST', 'ETL_USER'). Will be prefixed with space name. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries full burden and excels. It discloses that the tool is high-risk, requires user consent, auto-generates a password, and includes security notes (minimum privilege, audit retention). It also hints at the one-time nature of credential display.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with sections, bullet points, and code blocks. It front-loads the critical risk warning and example usage. Every sentence adds valueâno filler. Despite length, it remains scannable and organized.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the complexity (nested user_definition, high-risk, no output schema), the description is highly complete. It covers required parameters, JSON structure, security implications, and even includes CLI mapping. It leaves no ambiguity for an agent to misuse the tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% description coverage, but the description adds significant value: it explains the user_definition structure in detail, provides example JSON, clarifies that database_user_id will be prefixed with space name, and recommends the optional output_file for security. This goes well beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Create a new database user' and specifies the scope (in a SAP Datasphere space with permissions). It distinguishes from sibling tools like delete_database_user, reset_database_user_password, and update_database_user by focusing on creation. The provided example queries further clarify the purpose.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly lists when to use the tool (e.g., user requests create, setting up user access) and provides example queries. It does not explicitly state when not to use, but the contextual examples implicitly guide against misuse. The high-risk warning also sets expectations.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
delete_database_userA
Delete a database user from a SAP Datasphere space.
IMPORTANT: This is a HIGH-RISK tool that requires user consent before execution. WARNING: This action is IRREVERSIBLE. User and all associated permissions are permanently deleted.
Use this tool when:
User explicitly requests "Delete database user JEFF from SALES"
Decommissioning user accounts
Removing unauthorized access
Cleaning up test/temporary users
User left organization
What happens:
User account is permanently deleted
All active sessions terminated immediately
All granted privileges revoked
Cannot be undone - must recreate if needed
Deletion is logged for audit
Required parameters:
space_id: The space containing the database user
database_user_id: The user to delete
force: Optional flag to skip confirmation dialog
Safety considerations:
PERMANENT deletion - no recovery possible
Verify user identity and authorization
Check if user owns any objects (may cause errors)
Document reason for deletion
Consider deactivating instead of deleting
Before deleting:
List user's current permissions (list_database_users)
Verify no applications depend on this user
Check if user owns database objects
Get management approval for production users
Document deletion in change log
Example queries:
"Delete database user JEFF from SALES space"
"Remove TEMP_USER from FINANCE"
"Delete TEST_ANALYST - no longer needed"
Best practices:
Always confirm with user before deleting
Use force=false for interactive confirmation
Keep audit trail of deletions
For temporary removal, consider update instead
Note: Corresponds to CLI: datasphere dbusers delete --space --databaseuser [--force]
| Name | Required | Description | Default |
|---|---|---|---|
| force | No | Skip confirmation dialog. Default: false (ask for confirmation). Set true only if user explicitly confirmed deletion. | |
| space_id | Yes | The space ID containing the database user (e.g., 'SALES', 'FINANCE'). Must be uppercase. | |
| database_user_id | Yes | Database user name suffix to delete (e.g., 'JEFF', 'TEMP_USER'). WILL BE PERMANENTLY DELETED. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so the description carries the full burden. It thoroughly discloses the tool's high-risk nature, irreversibility, immediate termination of sessions, privilege revocation, and audit logging. The warnings are prominent and accurate.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Although lengthy, the description is well-organized with bold headings, bullet points, and numbered lists. Every section (warnings, when to use, what happens, parameters, safety considerations, before deleting, examples, best practices) serves a clear purpose. No redundant information, and the length is justified by the tool's high risk.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers all necessary aspects: purpose, usage guidelines, behavioral effects, parameter details, safety precautions, prerequisites, and examples. Despite no output schema, it explains what happens post-deletion (no recovery). It is comprehensive for a destructive tool with high potential impact.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Input schema already describes all 3 parameters, but the description adds valuable context beyond the schema. For example, it specifies the default for 'force' as false, reiterates the uppercase requirement for 'space_id', and uses examples to clarify parameter usage. This enhances understanding beyond the schema alone.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Delete a database user from a SAP Datasphere space' with a specific verb and resource. It distinguishes from sibling tools like create_database_user, update_database_user, and list_database_users by emphasizing the irreversible deletion and providing alternative actions like deactivation.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly lists when to use the tool (e.g., user explicitly requests deletion, decommissioning accounts) and when not to (consider deactivating instead). Provides a step-by-step checklist before deletion and best practices, which guides proper usage.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
execute_queryA
Execute read-only SQL queries against SAP Datasphere tables to retrieve and analyze data.
IMPORTANT: This is a HIGH-RISK tool that requires user consent before execution.
Use this tool when:
User explicitly requests data retrieval (e.g., "Show me customers from USA")
Need to perform data analysis with aggregations
Joining multiple tables for insights
Filtering and sorting data
Capabilities:
SELECT queries with full SQL syntax (WHERE, JOIN, GROUP BY, ORDER BY, LIMIT)
Read-only access - NO write operations allowed
Results limited to 100 rows by default (configurable via limit parameter)
Automatic query sanitization and injection prevention
Security & Restrictions:
Only SELECT statements allowed
Blocked operations: INSERT, UPDATE, DELETE, DROP, CREATE, ALTER, etc.
No SQL comments allowed (security risk)
Queries sanitized to prevent injection attacks
User consent required before execution (high-risk operation)
Query best practices:
Always specify a LIMIT to control result size
Use WHERE clauses to filter data efficiently
Check table schema first with get_table_schema()
Use qualified table names when joining
Example queries:
"SELECT * FROM CUSTOMER_DATA WHERE country = 'USA' LIMIT 10"
"SELECT customer_id, SUM(amount) as total FROM SALES_ORDERS GROUP BY customer_id ORDER BY total DESC LIMIT 20"
"SELECT c.customer_name, o.order_date, o.amount FROM CUSTOMER_DATA c JOIN SALES_ORDERS o ON c.customer_id = o.customer_id WHERE o.status = 'COMPLETED' LIMIT 50"
Error handling:
Invalid SQL syntax: Returns syntax error with guidance
Forbidden operations: Blocked with explanation
Missing tables: Suggests using search_tables() to find correct name
Permission denied: Explains consent requirement
Note: This tool uses mock data in development. Real query execution requires OAuth authentication.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of rows to return. Default: 100. Range: 1-1000. Use smaller limits for faster responses. | |
| space_id | Yes | The Datasphere space ID where tables exist (e.g., 'SALES_ANALYTICS', 'FINANCE_DWH'). Must be uppercase. | |
| sql_query | Yes | The SELECT query to execute. Must start with SELECT. Examples: 'SELECT * FROM CUSTOMER_DATA LIMIT 10', 'SELECT customer_id, COUNT(*) FROM SALES_ORDERS GROUP BY customer_id' |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description fully discloses behavior: read-only, high-risk requiring user consent, query sanitization, row limits, and development mock data. Error handling details are also included.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Well-structured with clear sections and front-loaded critical warnings. However, it is somewhat lengthy and contains some redundancy (e.g., read-only mentioned multiple times). For a high-risk tool, the length is acceptable.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the absence of an output schema and 3 parameters, the description covers behavior, security, best practices, examples, and error handling exceptionally well. It addresses prerequisites and provides actionable guidance for an agent.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline is 3. The description adds value with example queries for sql_query, clarifies space_id context (uppercase), and explains limit defaults and range. This goes slightly beyond schema but doesn't introduce new semantics.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool executes read-only SQL queries against SAP Datasphere tables, with specific verb and resource. It distinguishes from sibling tools like analyze_column_distribution and smart_query by emphasizing generic SQL execution and high-risk operations requiring consent.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly lists scenarios when to use (data retrieval, aggregation, joins) and provides best practices for query construction. Although it doesn't mention alternatives, the guidelines are comprehensive and include error handling guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
find_assets_by_columnA
Find all assets (tables/views) containing a specific column name across SAP Datasphere spaces.
Use this tool when:
User asks "Which tables contain CUSTOMER_ID?"
Performing data lineage analysis
Impact analysis before schema changes
Finding datasets for specific use cases
Locating related data across spaces
What you'll get:
Asset names and types (View, Table, etc.)
Space IDs where assets are located
Column information (name, type, position)
Total column count per asset
Consumption URLs for data access
Use cases:
Data lineage discovery (find all uses of a column)
Impact analysis (before renaming/removing columns)
Dataset discovery (find tables with specific fields)
Cross-space data exploration
Schema relationship mapping
Example queries:
"Find all tables with CUSTOMER_ID column"
"Which views contain SALES_AMOUNT?"
"Show me assets with COUNTRY_CODE in SAP_CONTENT space"
"List tables that have ORDER_DATE column"
Performance notes:
Searches across multiple spaces by default
Uses intelligent caching for better performance
Results limited to 50 assets by default (configurable)
Case-insensitive search by default
| Name | Required | Description | Default |
|---|---|---|---|
| space_id | No | Optional: Limit search to specific space (e.g., 'SAP_CONTENT'). Leave empty to search all spaces. | |
| max_assets | No | Optional: Maximum number of matching assets to return (1-200). Default: 50 | |
| column_name | Yes | Column name to search for (case-insensitive by default). Examples: 'CUSTOMER_ID', 'SALES_AMOUNT', 'ORDER_DATE' | |
| case_sensitive | No | Optional: Perform case-sensitive column name matching. Default: false |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description fully covers behavior: search across spaces, caching, default limits, case-insensitivity. It also details what the agent will receive in results, ensuring no surprises.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with sections and bullets, and the first sentence clearly states the purpose. However, some repetition exists (e.g., 'Use cases' overlaps with 'Use this tool when'), making it slightly longer than necessary.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given 4 parameters and no output schema, the description adequately explains what is returned (asset names, types, space IDs, column info, etc.) and includes performance notes. Covers all essential context for an agent.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline is 3. The description adds usage examples but no new semantic info beyond the schema's parameter descriptions. Minimal added value.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'find' and the resource 'assets containing a specific column name across SAP Datasphere spaces.' This is distinct from sibling tools like search_catalog or search_tables, which are broader. No ambiguity.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The 'Use this tool when' section lists specific queries and use cases (data lineage, impact analysis). It provides explicit context but does not mention when not to use or alternatives, so it's slightly below the top tier.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_analytical_metadataB
Retrieve CSDL metadata for analytical consumption of a specific asset. Returns analytical schema with dimensions, measures, hierarchies, and aggregation information for BI and analytics integration. Automatically identifies analytical elements based on SAP annotations.
| Name | Required | Description | Default |
|---|---|---|---|
| asset_id | Yes | Asset identifier (e.g., 'SAP_SC_FI_AM_FINTRANSACTIONS') | |
| space_id | Yes | Space identifier (e.g., 'SAP_CONTENT') | |
| identify_dimensions_measures | No | Automatically identify dimensions and measures based on annotations (default: true) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries full burden for behavioral disclosure. It mentions automatic identification based on SAP annotations but does not state performance implications, error handling, or whether the operation is read-only. The read-only nature is implied but not explicit.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise with two sentences, front-loading the core purpose. It avoids redundancy but could be slightly more structured, e.g., by listing return fields explicitly. Still, it earns its place with no wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the lack of output schema, the description should more fully describe the returned structure (e.g., hierarchy details, field types). It mentions dimensions, measures, hierarchies, and aggregation info but omits details on error conditions or response format, making it incomplete for a metadata retrieval tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with clear descriptions for all three parameters. The description adds context about the identify_dimensions_measures parameter by linking it to SAP annotations, but this is already in the schema. Baseline score of 3 is appropriate as no significant additional meaning is provided.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it retrieves CSDL metadata for analytical consumption, including dimensions, measures, hierarchies, and aggregation information. It distinguishes from siblings like get_analytical_model and get_relational_metadata by focusing on analytical schema for BI integration.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is provided on when to use this tool versus alternatives such as get_analytical_model or list_analytical_datasets. The description lacks context about prerequisites or scenarios where this tool is preferred.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_analytical_modelA
Get the OData service document and metadata for a specific analytical model. Returns entity sets, dimensions, measures, and query capabilities. Parses CSDL metadata (OData V4) to identify analytical properties via Common.Label / Analytics.Dimension / Analytics.Measure / Analytics.AggregationRole annotations, with V2 sap:* attributes kept as a fallback.
| Name | Required | Description | Default |
|---|---|---|---|
| asset_id | Yes | Asset identifier | |
| space_id | Yes | Space identifier | |
| include_metadata | No | Include parsed CSDL metadata with dimensions and measures (default: true) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description carries full burden. It explains return content and parsing logic (CSDL, annotations, fallback), but omits side effects, authentication requirements, or error handling. Adequate but not comprehensive.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, no redundancy. First sentence states purpose and output, second sentence provides technical detail. Every word serves a purpose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no output schema and no annotations, the description adequately explains the tool's return content (dimensions, measures, entity sets) and parsing methodology. Lacks output format specifics and error scenarios, but sufficient for a retrieval tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema covers 100% of parameters with descriptions. The description adds technical context about returned metadata and parsing approach but does not elaborate on parameter syntax or constraints beyond the schema. Baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it retrieves the OData service document and metadata for a specific analytical model, listing key components (entity sets, dimensions, measures, query capabilities). It distinguishes itself from siblings by focusing on a single model's metadata with parsing details.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this tool versus alternatives like get_analytical_metadata or list_analytical_datasets. Lacks context on prerequisites, exclusions, or typical use cases.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_asset_by_compound_keyA
Retrieve asset using OData compound key identifier (alternative access method).
Use this tool when:
You have both space ID and asset ID ready
Want direct access without knowing the exact endpoint structure
Working with bookmarked or favorited assets
Have pre-known asset identifiers from other systems
Need to resolve cross-references quickly
What you'll get:
Same comprehensive metadata as get_asset_details
Complete asset information with consumption URLs
All dimensions, measures, and relationships
Technical and business context
Required parameters:
space_id: The space identifier
asset_id: The asset identifier
How it works:
This tool combines space_id and asset_id into an OData compound key format:
spaceId='SAP_CONTENT',assetId='SAP_SC_FI_AM_FINTRANSACTIONS'
Example queries:
"Get asset SAP_SC_FI_AM_FINTRANSACTIONS from SAP_CONTENT using compound key"
"Retrieve CUSTOMER_VIEW in SALES_SPACE"
When to use this vs get_asset_details:
Use this: When you want simplified parameter passing
Use get_asset_details: When you need expand options or prefer explicit endpoint
Note: This uses the Catalog API: GET /api/v1/datasphere/consumption/catalog/assets({compoundKey})
| Name | Required | Description | Default |
|---|---|---|---|
| asset_id | Yes | The asset identifier (e.g., 'SAP_SC_FI_AM_FINTRANSACTIONS', 'CUSTOMER_VIEW'). | |
| space_id | Yes | The space identifier in UPPERCASE (e.g., 'SAP_CONTENT', 'SALES_SPACE'). |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. It explains the compound key format and underlying API call, but could mention idempotency or error scenarios for completeness.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is thorough but lengthy with multiple sections. It could be more concise while retaining key information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no output schema, the description adequately explains what is returned (same as get_asset_details, comprehensive metadata). It provides a complete picture for the tool's usage.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so parameters are already well-documented. The description adds value by showing the compound key format and providing examples, going beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it retrieves an asset using a compound key, and explicitly distinguishes it from the sibling tool 'get_asset_details' by noting it offers simplified parameter passing.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides explicit guidance on when to use (having space_id and asset_id, cross-references) and when to use the alternative 'get_asset_details' (for expand options). Includes example queries.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_asset_detailsA
Get comprehensive metadata for a specific SAP Datasphere asset.
Use this tool when:
User asks "Show me details about the Financial Transactions asset"
Need complete asset documentation and structure
Want to understand asset dimensions, measures, and relationships
Looking for consumption URLs to access the data
Checking asset business purpose and technical details
Validating asset availability before integration
What you'll get:
Complete asset metadata (name, description, business purpose)
Space information and ownership details
Asset type and consumption type (analytical/relational)
Consumption URLs for data access
Metadata URLs for schema information
Dimensions and measures (for analytical models)
Relationships to other assets
Technical details (row count, size, refresh info)
Business context (domain, classification, retention)
Version and status information
Tags and categorization
Required parameters:
space_id: The space containing the asset (e.g., 'SAP_CONTENT')
asset_id: The asset identifier (e.g., 'SAP_SC_FI_AM_FINTRANSACTIONS')
Optional parameters:
expand_fields: Related entities to expand (e.g., ['columns', 'relationships'])
Example queries:
"Get details for SAP_SC_FI_AM_FINTRANSACTIONS in SAP_CONTENT"
"Show me the structure of the Financial Transactions asset"
"What are the dimensions and measures of this analytical model?"
"Give me the consumption URL for the Sales Data View"
Use cases:
Understand asset structure before querying
Get consumption URLs for data access
Review asset business purpose and classification
Check asset relationships and dependencies
Validate data freshness (last refresh time)
Generate asset documentation
Note: This uses the Catalog API: GET /api/v1/datasphere/consumption/catalog/spaces('{spaceId}')/assets('{assetId}')
| Name | Required | Description | Default |
|---|---|---|---|
| asset_id | Yes | The asset identifier (e.g., 'SAP_SC_FI_AM_FINTRANSACTIONS', 'CUSTOMER_VIEW'). | |
| space_id | Yes | The space ID in UPPERCASE format (e.g., 'SAP_CONTENT', 'SALES_ANALYTICS'). Must match exactly. | |
| expand_fields | No | Related entities to expand (e.g., ['columns', 'relationships', 'metadata']). |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description carries full burden. It mentions the API endpoint and return data fields, but does not explicitly state read-only nature or discuss side effects, auth needs, or rate limits. Adequate but could be more explicit.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Well-structured with sections, bullet lists, and examples. Each section adds value, though the length is slightly above necessary. Front-loaded with purpose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
No output schema, but the description comprehensively lists what metadata will be returned, covers params, examples, use cases, and API details. Lacks error conditions but adequate for the tool's complexity.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with descriptions. The description adds value with examples, format hints (UPPERCASE for space_id), and explanation of optional expand_fields, enhancing beyond schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'Get' and resource 'comprehensive metadata for a specific SAP Datasphere asset.' It distinguishes from siblings like get_space_assets (list) and get_analytical_model (specific model type).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides explicit 'Use this tool when:' with examples, 'What you'll get', 'Use cases', and example queries. Does not state when NOT to use or name alternatives explicitly, but context is clear.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_asset_variablesA
Retrieve input parameters/variables and filter-capability annotations declared in the OData $metadata of a SAP Datasphere asset (wave 2026.10). Use this when the asset is parameterised (e.g., a view or analytic model with input variables) and you need to know what variables to bind and which fields are filterable/sortable before querying. Returns variables (name, type, default, nullable, multi_value), filter annotations, and the column list.
| Name | Required | Description | Default |
|---|---|---|---|
| asset_id | Yes | Asset identifier (view or analytic model exposed for consumption) | |
| space_id | Yes | Space identifier (e.g., 'SAP_CONTENT') |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description fully discloses the tool returns variables (name, type, default, nullable, multi_value), filter annotations, and the column list. It implies a read-only operation and adds context beyond the name, though it could mention prerequisites like asset deployment status.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences: first states core functionality, second adds usage guidance. It is relatively concise and well-structured, though the first sentence is slightly lengthy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with 2 params, no output schema, and no annotations, the description provides a good overview of inputs and outputs. However, it lacks details on output structure (e.g., array of objects) and possible error conditions, leaving some gaps in completeness.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with descriptions for both parameters. The description adds some context by explaining the asset type (view/analytic model), but does not significantly enhance the meaning beyond the schema. Baseline of 3 is appropriate given high coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool retrieves input parameters/variables and filter-capability annotations from OData $metadata of a SAP Datasphere asset. It specifies the verb 'Retrieve' and the resource, and distinguishes from siblings by mentioning it is for parameterised assets like views or analytic models.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly says when to use this tool: when the asset is parameterised and variables need to be known before querying. It provides clear context for use but does not mention when not to use it or suggest alternatives among the many sibling tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_available_scopesA
List available OAuth2 scopes for the current user, showing which scopes are granted and which are available but not granted. Includes scope descriptions and the token's current scopes. Use this to understand API access capabilities and troubleshoot permission issues.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden. It describes the listing behavior but does not explicitly state it is read-only or safe. The name implies a read operation, but additional context on safety or side effects would be beneficial.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences: first states what the tool does, second provides a use case. No unnecessary words, effectively efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no output schema, the description adequately covers what the tool returns (scopes, granted/available status, descriptions, token scopes). For a simple list tool, this is sufficiently complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has no parameters, so the description cannot add meaning beyond the schema. Baseline for 0 parameters is 4, and the description appropriately focuses on the tool's output.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool lists OAuth2 scopes, distinguishing between granted and available, and includes descriptions and current token scopes. This is specific and differentiates from siblings which do not deal with OAuth scopes.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description advises using the tool to understand API access capabilities and troubleshoot permissions. While it doesn't explicitly state when not to use it, the context is clear and no alternatives are needed given the tool's unique purpose.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_current_userA
Get authenticated user information including user ID, email, display name, roles, permissions, and account status. Use this to understand the current user's identity and access rights in SAP Datasphere.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. It discloses the returned fields but does not mention potential errors, authentication requirements beyond being authenticated, or side effects. For a simple read tool, this is acceptable but not exhaustive.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Single, well-structured sentence that front-loads the purpose and details, with no superfluous words. Every part adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a parameterless tool with no output schema, the description fully covers what the tool does and what it returns, listing specific fields. No additional information is necessary for an agent to use it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has no parameters (0), so the baseline is 4. The description does not need to add meaning as there are no parameters to document.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'Get' and the resource 'authenticated user information', listing specific fields (user ID, email, etc.), and distinguishes itself from sibling tools which focus on different aspects like spaces or tenants.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description says 'Use this to understand the current user's identity and access rights', providing clear context. It does not explicitly mention when not to use it or alternatives, but given its unique purpose, this is adequate.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_deployed_objectsA
List runtime/deployed objects that are actively running in SAP Datasphere. Returns deployment status, runtime metrics, execution history for data flows, and performance statistics. Use this for monitoring deployed assets, tracking execution status, analyzing runtime performance, and identifying active vs inactive objects.
| Name | Required | Description | Default |
|---|---|---|---|
| top | No | Maximum number of results to return (default: 50, max: 500) | |
| skip | No | Number of results to skip for pagination (default: 0) | |
| space_id | Yes | Space identifier (e.g., 'SAP_CONTENT') | |
| object_types | No | Filter by object types: Table, View, AnalyticalModel, DataFlow | |
| runtime_status | No | Filter by runtime status: Active, Running, Idle, Error, Suspended | |
| include_metrics | No | Include runtime performance metrics (query times, execution stats, cache hit rates) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. It indicates that the tool returns runtime data but does not disclose whether it is read-only, requires specific permissions, or has any rate limits. It is adequate but minimally transparent beyond stating the output.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise with two main sentences plus a list of use cases. It front-loads the core purpose and avoids verbosity. The structure is clear and efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool has 6 parameters and no output schema, the description adequately covers the returned data types but lacks details on pagination behavior (beyond schema) and result structure. It is minimally complete for the complexity.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all parameters well. The description adds no additional meaning beyond the overall purpose. It does not explain parameter relationships or provide examples, meeting the baseline but not exceeding it.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose with a specific verb ('List') and resource ('runtime/deployed objects'). It further elaborates on what is returned (deployment status, runtime metrics, execution history, performance statistics) and lists use cases. This distinguishes it from sibling tools like 'get_asset_details' which focus on non-runtime aspects.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit use cases for monitoring and analysis (monitoring deployed assets, tracking execution status, analyzing runtime performance). However, it does not mention when not to use this tool or suggest alternatives, which slightly reduces guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_object_definitionA
Get complete design-time object definition from SAP Datasphere repository. Retrieves detailed structure, logic, transformations, and metadata for tables (with columns, keys, indexes), views (with SQL definitions), analytical models (with dimensions/measures), and data flows (with transformation steps). Use this for understanding object implementation details, extracting schema information, or planning migrations.
| Name | Required | Description | Default |
|---|---|---|---|
| space_id | Yes | Space identifier (e.g., 'SAP_CONTENT') | |
| object_id | Yes | Object identifier/name (e.g., 'FINANCIAL_TRANSACTIONS', 'CUSTOMER_VIEW') | |
| include_dependencies | No | Include dependency information (upstream sources and downstream consumers) | |
| include_full_definition | No | Include complete object definition with all details (columns, transformations, logic) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the burden. It implies read-only behavior by describing retrieval of structure and metadata, but does not disclose authentication needs, rate limits, or error handling (e.g., object not found). Adds some value beyond schema but incomplete.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with zero waste. Front-loaded with purpose, followed by detailed examples of what is retrieved for each object type. Efficient and scannable.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool has 4 parameters and no output schema. Description explains what it returns for different object types (tables, views, models, data flows). Missing are error cases, performance notes, or output format hints, but overall sufficient for typical use.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all parameters. Description provides general context (e.g., example values) but does not add significant additional meaning beyond what the schema provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description clearly states the tool retrieves complete design-time object definitions from SAP Datasphere repository, listing specific object types (tables with columns/keys/indexes, views with SQL, analytical models with dimensions/measures, data flows with transformation steps). It distinguishes from siblings like get_table_schema or get_analytical_model by emphasizing 'complete' and broad coverage.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Description explicitly states use cases: 'understanding object implementation details, extracting schema information, or planning migrations.' It provides clear context but does not mention when not to use or suggest alternatives, which would have made it stronger.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_relational_entity_metadataA
Get detailed metadata for a specific relational entity including column definitions, data types, SQL type mappings, and ETL extraction capabilities. Optimized for data warehouse loading and transformation workflows.
| Name | Required | Description | Default |
|---|---|---|---|
| asset_id | Yes | Asset/entity identifier (e.g., 'SAP_SC_FI_AM_FINTRANSACTIONS') | |
| space_id | Yes | Space identifier (e.g., 'SAP_CONTENT') | |
| include_sql_types | No | Include SQL type mappings for target databases (default: true) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description alone must convey behavioral traits. It describes a read operation but does not disclose potential side effects, permissions required, rate limits, or how missing identifiers are handled. The lack of detail is insufficient for full transparency.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences that are front-loaded with the tool's purpose and value. Every sentence adds meaning; no redundant or filler content. Ideal length for quick comprehension.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the lack of an output schema and moderate complexity, the description covers the key return items (columns, types, mappings, ETL capabilities). It could be slightly more explicit about the output format (e.g., JSON), but overall it provides sufficient context for its straightforward metadata retrieval purpose.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema covers all three parameters with descriptions (100% coverage). The description adds context about the returned data but does not significantly enhance parameter semantics beyond what the schema already provides. Baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool gets detailed metadata for a specific relational entity, listing concrete details like column definitions, data types, SQL type mappings, and ETL extraction capabilities. It distinguishes itself from siblings by emphasizing optimization for data warehouse loading and transformation workflows.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description mentions it is 'optimized for data warehouse loading and transformation workflows,' which implies a use case but does not explicitly state when to use this tool versus alternatives like 'get_relational_metadata' or 'get_table_schema'. No exclusion or alternative guidance is provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_relational_metadataA
Retrieve CSDL metadata for relational consumption of a specific asset. Returns complete schema information including tables, columns, data types, primary/foreign keys, and relationships for relational data access and ETL planning. Includes SQL type mapping.
| Name | Required | Description | Default |
|---|---|---|---|
| asset_id | Yes | Asset identifier (e.g., 'CUSTOMER_VIEW') | |
| space_id | Yes | Space identifier (e.g., 'SAP_CONTENT') | |
| map_to_sql_types | No | Map OData types to SQL types (default: true) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden. It discloses the return includes schema information and SQL type mapping, but lacks details on side effects, authentication requirements, or rate limits. Adequate but not exhaustive.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences, front-loaded with the primary purpose, and each sentence adds valueâno wasted words. Ideal conciseness.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given 3 parameters, no output schema, and presence of sibling tools, the description adequately covers purpose, included schema elements, and SQL type mapping. It lacks details on output structure or potential edge cases, but is mostly complete for a retrieval tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, and the description adds no additional meaning beyond the schema's parameter descriptions (e.g., 'Space identifier (e.g., 'SAP_CONTENT')'). With high coverage, baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Retrieve CSDL metadata for relational consumption of a specific asset,' specifying the verb (retrieve) and resource (CSDL metadata for a specific asset). It lists included elements (tables, columns, data types, keys, relationships) and distinguishes it from siblings like get_analytical_metadata or get_table_schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description indicates usage for 'relational consumption' and 'relational data access and ETL planning,' providing context. However, it does not explicitly state when not to use or offer alternatives, though sibling tool names like get_analytical_metadata serve as implicit contrasts.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_space_assetsA
List all data assets within a specific SAP Datasphere space.
Use this tool when:
User asks "What assets are in the SAP_CONTENT space?"
Browsing assets within a specific space
Creating a space-specific asset inventory
Filtering assets by type within a space
Validating space contents and available data
Understanding what data is available in a space
What you'll get:
All assets within the specified space
Asset names, descriptions, and types
Exposure status for each asset
Consumption URLs (analytical and relational)
Creation and modification timestamps
Asset counts and pagination info
Required parameters:
space_id: The space to browse (e.g., 'SAP_CONTENT')
Optional parameters:
filter_expression: Filter by asset type or other criteria
top: Maximum results (default 50, max 1000)
skip: Results to skip for pagination
Example queries:
"List all assets in the SAP_CONTENT space"
"Show me analytical models in SALES_ANALYTICS"
"What tables are available in FINANCE_SPACE?"
"List exposed assets in SAP_CONTENT"
Common filters:
By type:
filter_expression="assetType eq 'AnalyticalModel'"Exposed only:
filter_expression="exposedForConsumption eq true"By name pattern:
filter_expression="contains(name, 'Financial')"Combined:
filter_expression="assetType eq 'View' and exposedForConsumption eq true"
Asset types:
AnalyticalModel: Multi-dimensional models with dimensions and measures
View: SQL views combining data from multiple sources
Table: Physical tables with business data
Fact: Fact tables in dimensional models
Dimension: Dimension tables for analysis
Use cases:
Space content discovery
Asset inventory generation
Data availability validation
Finding specific asset types
Understanding space data landscape
Note: This uses the Catalog API: GET /api/v1/datasphere/consumption/catalog/spaces('{spaceId}')/assets
| Name | Required | Description | Default |
|---|---|---|---|
| top | No | Maximum number of results to return (default: 50, max: 1000). | |
| skip | No | Number of results to skip for pagination (default: 0). | |
| space_id | Yes | The space ID in UPPERCASE format (e.g., 'SAP_CONTENT', 'SALES_ANALYTICS'). Must match exactly. | |
| filter_expression | No | OData filter expression (e.g., "assetType eq 'AnalyticalModel'" or "exposedForConsumption eq true"). |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Since no annotations are provided, the description carries the full burden. It details what the tool returns: asset names, descriptions, types, exposure status, consumption URLs, timestamps, counts, pagination. It also notes the underlying API call. It does not mention auth requirements or rate limits, but for a read-only listing tool, the transparency is high.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is fairly long but well-structured into clear sections (use cases, parameters, examples, filters, asset types). Each section adds relevant information without redundancy. It is appropriately sized for the tool's complexity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the 4 parameters, no output schema, and no annotations, the description is remarkably complete. It covers all parameter usage, provides practical examples, common OData filter patterns, and lists asset types. An agent can fully understand how to invoke the tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline is 3. The description adds significant value with example values ('SAP_CONTENT'), default values for top and skip, common filter examples, and descriptions of asset types. This goes beyond the schema definitions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'List all data assets within a specific SAP Datasphere space' with a specific verb and resource. It distinguishes from siblings like list_catalog_assets and search_catalog by focusing on assets within a single space.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly lists user queries and scenarios that trigger the tool, such as 'What assets are in the SAP_CONTENT space?' and 'Filtering assets by type within a space.' However, it does not provide explicit when-not-to-use guidance or name alternative tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_space_infoA
Get comprehensive information about a specific SAP Datasphere space.
Use this tool when:
User asks about a specific space (e.g., "Tell me about SALES_ANALYTICS")
You need to see what tables/views exist in a space
Checking space configuration and metadata
Following up from list_spaces() results
What you'll get:
Complete space metadata (status, owner, created date)
List of all tables and views in the space
Table schemas and row counts
Connection information
Required parameter:
space_id: Must be uppercase (e.g., 'SALES_ANALYTICS', 'FINANCE_DWH')
Example queries:
"Show me the SALES_ANALYTICS space"
"What tables are in FINANCE_DWH?"
"Tell me about the HR_ANALYTICS space"
Error handling:
If space not found, list_spaces() will show available spaces
| Name | Required | Description | Default |
|---|---|---|---|
| space_id | Yes | The space ID in UPPERCASE format (e.g., 'SALES_ANALYTICS', 'FINANCE_DWH', 'HR_ANALYTICS'). Must match exactly. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, but description clearly implies a read-only operation ('Get comprehensive information') and lists what will be returned. It adds context like uppercase requirement for space_id. Could be more explicit about being read-only or lack of side effects.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Well-structured with sections for usage, output, parameters, examples, and error handling. Every sentence is meaningful and adds value. No unnecessary text.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple tool with one parameter and no output schema, the description covers all necessary aspects: purpose, when to use, parameter details, example queries, and error handling. It is complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so schema already documents the parameter. Description adds value by specifying the uppercase requirement and providing example queries, though it largely restates the schema description.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description explicitly states 'Get comprehensive information about a specific SAP Datasphere space' and lists specific outputs (metadata, tables/views, schemas). It clearly distinguishes from siblings like list_spaces by specifying it targets a single space.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides explicit 'Use this tool when:' section with concrete scenarios (user asks about a space, need to see tables/views, follow-up from list_spaces). Also gives error handling guidance (if space not found, use list_spaces).
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_table_schemaA
Get detailed schema information for a specific table or view.
Use this tool when:
User asks "What columns are in CUSTOMER_DATA?"
Need to understand table structure before querying
Planning JOIN operations (need to see key columns)
Checking data types for analysis
What you'll get:
Complete column list with data types
Primary key indicators
Column descriptions
Table metadata (row count, last updated)
Required parameters:
space_id: The space containing the table (uppercase)
table_name: Exact table name (case-sensitive, usually uppercase)
Example queries:
"Show me the schema of CUSTOMER_DATA in SALES_ANALYTICS"
"What columns does SALES_ORDERS have?"
"Describe the GL_ACCOUNTS table structure"
Best practices:
Use search_tables() first if you don't know the exact table name
Check column types before writing queries
Identify key columns for JOINs
Next steps:
Use execute_query() with proper column names and types
| Name | Required | Description | Default |
|---|---|---|---|
| space_id | Yes | The space ID containing the table (e.g., 'SALES_ANALYTICS'). Must be uppercase. | |
| table_name | Yes | Exact table or view name (e.g., 'CUSTOMER_DATA', 'SALES_ORDERS'). Case-sensitive, typically uppercase. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description fully explains the output: column list, data types, primary keys, column descriptions, and table metadata. It doesn't mention permissions or rate limits, but for a read-only schema tool, the behavioral disclosure is sufficient and accurate.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with clear sections (use cases, what you'll get, required parameters, examples, best practices). It is front-loaded with the core purpose. Though somewhat lengthy, every section contributes useful context without redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Despite lacking an output schema, the description details the output contents and provides a complete usage flow: prerequisites (search_tables), inputs, and next steps (execute_query). It addresses all common use cases and integrates well with sibling tools.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and the description largely repeats parameter information (case-sensitivity, uppercase). It adds value through examples (e.g., 'SALES_ANALYTICS') and context, but the baseline for high coverage is 3, and the description doesn't substantially enhance understanding beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool retrieves schema information for a table or view. It differentiates from siblings by explicitly mentioning using search_tables() if the table name is unknown, and contrasts with execute_query() for querying. Examples reinforce the specific use case.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The 'Use this tool when' section lists concrete scenarios like checking columns or planning JOINs. Best practices advise using search_tables() first if uncertain, and Next steps suggest execute_query() after schema retrieval. This provides clear guidance on when to use and what alternatives exist.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_task_historyA
Get the execution history for a specific task chain or object in SAP Datasphere.
Use this tool when:
Viewing all previous runs of a task chain
Analyzing task execution patterns
Finding failed runs to investigate
Checking historical performance
Auditing task chain executions
Understanding run frequency and duration
What you'll get:
Array of all historical task runs for the specified object
Each entry includes: logId, status, startTime, endTime, runTime
Sorted by most recent first
Shows RUNNING, COMPLETED, FAILED, CANCELLED runs
Required parameters:
space_id: The space containing the task chain
object_id: The task chain name to get history for
Response includes for each run:
logId: Unique identifier for this execution
status: RUNNING, COMPLETED, FAILED, or CANCELLED
startTime: When the task started (ISO format)
endTime: When the task finished (if completed)
runTime: Duration in milliseconds
objectId: The task chain name
applicationId: Always 'TASK_CHAINS' for task chains
activity: The activity type (e.g., 'RUN_CHAIN')
user: Who initiated the run
Example queries:
"Show me the run history for Daily_ETL_Pipeline in SALES_SPACE"
"List all executions of Customer_Sync in FINANCE"
"Get historical runs for Nested_Chain_1 in DWH_SPACE"
"How many times has Data_Refresh run this week?"
Use cases:
Identify recurring failures
Analyze execution duration trends
Find specific failed runs to debug
Audit who ran tasks and when
Plan maintenance windows
Monitor SLA compliance
Workflow example:
Get history: get_task_history(space_id='SALES', object_id='Daily_ETL')
Find failed run: Look for status='FAILED', note logId
Get details: get_task_log(space_id='SALES', log_id=, detail_level='detailed')
View error messages in the response
Note: Uses API: GET /api/v1/datasphere/tasks/logs/{space_id}/objects/{object_id}
| Name | Required | Description | Default |
|---|---|---|---|
| space_id | Yes | The space ID containing the task chain (e.g., 'SALES_SPACE', 'FINANCE'). Must be uppercase. | |
| object_id | Yes | The task chain name/identifier to get history for (e.g., 'Daily_ETL_Pipeline', 'Customer_Sync'). |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description fully discloses the tool's behavior: it returns a sorted array of runs with fields like logId, status, timestamps. It notes the API endpoint and that it's a GET request, indicating a safe read operation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-organized with bullet points and sections, but is somewhat lengthy. However, every section adds value, and the most important information is front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no output schema, the description details the response structure, includes example queries and use cases, and provides a workflow example. It lacks mention of pagination or limits, but is otherwise thorough.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, but the description adds value with examples, required parameter listing, and context on parameter values (e.g., uppercase space IDs). This goes beyond the schema descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool fetches execution history for a task chain or object in SAP Datasphere, with a specific verb and resource. It distinguishes from siblings like get_task_log and get_task_status.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides a comprehensive list of when to use the tool, including analyzing runs and finding failures. It gives a workflow example showing integration with get_task_log, but does not explicitly state when not to use it.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_task_logA
Get detailed information about a specific task execution in SAP Datasphere.
Use this tool when:
Checking status of a running task (after run_task_chain)
Investigating why a task failed
Viewing detailed execution logs and messages
Monitoring task chain progress
Debugging data pipeline issues
What you'll get (depends on detail_level):
status (default): Simple status object {"status": "COMPLETED"}
status_only: Just the status string "COMPLETED"
detailed: Full details including messages and child nodes
extended: Extended logs with complete message details
Required parameters:
space_id: The space where the task ran
log_id: The log ID from run_task_chain or get_task_history
Optional parameters:
detail_level: Amount of detail to return
'status' (default): Status object only
'status_only': Status string only
'detailed': Full logs with messages and children
'extended': Extended logs with message details
Status values:
RUNNING: Task is currently executing
COMPLETED: Task finished successfully
FAILED: Task encountered an error
CANCELLED: Task was manually stopped
Example queries:
"Check status of task log 2295172 in SALES_SPACE"
"Get detailed logs for log ID 2295172"
"Show me why task 2326060 failed in FINANCE"
"Get extended execution details for log 2295172"
Detailed response includes:
logId, status, startTime, endTime, runTime
objectId (task chain name)
user who ran the task
children: Array of child task executions
messages: Array of log messages with severity and timestamps
Use cases:
Monitor long-running ETL jobs
Debug failed data pipelines
Audit task execution history
Track data refresh timing
Investigate error messages
Note: Uses API: GET /api/v1/datasphere/tasks/logs/{space_id}/{log_id}
| Name | Required | Description | Default |
|---|---|---|---|
| log_id | Yes | The log ID to retrieve details for (obtained from run_task_chain or get_task_history). | |
| space_id | Yes | The space ID where the task ran (e.g., 'SALES_SPACE', 'FINANCE'). Must be uppercase. | |
| detail_level | No | Level of detail to return. Options: 'status' (default), 'status_only', 'detailed', 'extended'. | status |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. It discloses the API endpoint, response structure per detail_level, status values, and example queries. It does not mention rate limits or auth, but for a read operation, the provided information is sufficient and transparent.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is longer but well-structured with clear sections (use cases, parameters, status values, example queries). It front-loads the purpose and organizes information logically. While some redundancy exists (e.g., repeating detail_level options), it remains efficient for the complexity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no output schema, the description compensates by detailing the response for each detail_level, status values, and providing example queries. It covers use cases and prerequisites. The tool's complexity (multiple detail options) is addressed adequately.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, but the description adds value beyond the schema: it specifies that space_id must be uppercase, log_id is obtained from specific tools, detail_level defaults to 'status', and explains each option. This extra context helps the agent use parameters correctly.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose: 'Get detailed information about a specific task execution'. It uses a specific verb+resource and distinguishes from siblings like get_task_history (which lists logs) and get_task_status (which likely returns simpler status) by specifying that log_id comes from those tools and offering multiple detail levels.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly lists when to use the tool with bullet points (e.g., checking status, investigating failures, monitoring progress). It does not directly exclude alternatives, but the use cases are specific enough to guide selection. The note about log_id source (from run_task_chain or get_task_history) provides necessary context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_task_statusA
Get status and execution details of data integration and ETL tasks.
Use this tool when:
User asks "What tasks are running?"
Monitoring data pipeline execution
Checking when data was last refreshed
Troubleshooting failed tasks
What you'll get:
Task IDs and names
Execution status (COMPLETED, RUNNING, FAILED, SCHEDULED)
Last run timestamp and next scheduled run
Execution duration and records processed
Associated space information
Filtering options:
No parameters: Show all tasks
task_id: Get specific task details
space_id: Show all tasks for a space
Example queries:
"What tasks are currently running?"
"Show me all tasks in SALES_ANALYTICS"
"When did DAILY_SALES_ETL last run?"
"Check status of task FINANCE_RECONCILIATION"
Task types:
ETL/data loading tasks
Transformation workflows
Scheduled data refreshes
Data replication jobs
| Name | Required | Description | Default |
|---|---|---|---|
| task_id | No | Optional: Specific task ID to check (e.g., 'DAILY_SALES_ETL'). Leave empty to see all tasks. | |
| space_id | No | Optional: Filter tasks by space (e.g., 'SALES_ANALYTICS'). Shows only tasks associated with that space. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden. It discloses the output structure (task IDs, status, timestamps, etc.), filtering behavior, and task types. However, it does not mention if the tool is read-only, required permissions, or any rate limits, which would add transparency.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with sections (use cases, output fields, filtering options, examples) and uses bullet points for readability. It is comprehensive yet concise, with every section adding value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given that there is no output schema, the description thoroughly explains the expected return values (task IDs, status, timestamps, duration, records processed, space info). It also covers filtering options and provides example queries, making it complete for an agent to use correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema already has clear descriptions for both parameters (100% coverage). The description adds context by explaining the effect of no parameters ('Show all tasks') and providing example usage, which goes beyond the schema and helps the agent understand parameter semantics.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the purpose: 'Get status and execution details of data integration and ETL tasks.' It specifies the verb 'Get' and resource 'task status/execution details', distinguishing it from sibling tools like get_task_history or get_task_log.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit when-to-use scenarios (e.g., 'What tasks are running?', 'Monitoring data pipeline execution') and example queries. However, it does not explicitly mention when not to use this tool or compare to alternative tools, which would elevate it to a 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_tenant_infoA
Retrieve SAP Datasphere tenant configuration and system information including tenant ID, region, version, license type, storage quota/usage, user count, space count, enabled features, and maintenance windows. Use this for system administration and capacity planning.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. It states the tool 'retrieves' information, indicating a read-only operation, and enumerates the returned data. It does not mention authorization requirements or rate limits, but the nature of a read-only configuration tool is adequately transparent.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise, consisting of two sentences. The first sentence front-loads the purpose and scope, while the second provides usage guidance. Every sentence adds value with no wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given zero parameters, no output schema, and no annotations, the description fully covers the essential information: what the tool does, what data it returns, and when to use it. It leaves no significant gaps for a simple retrieval tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has no parameters (0 params, baseline 4). The description does not need to add parameter information beyond the schema, which is already 100% coverage. It appropriately describes what the tool returns without referencing parameters.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool retrieves 'SAP Datasphere tenant configuration and system information' and lists specific fields like tenant ID, region, version, license type, storage quota/usage, user count, space count, enabled features, and maintenance windows. This verb+resource combination is specific and distinct from sibling tools like get_space_info or get_asset_details, which focus on other scopes.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly says 'Use this for system administration and capacity planning,' providing a clear use case. While it does not exclude alternatives or mention when not to use, the context is sufficient for a simple read-only tool with no side effects.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_analytical_datasetsA
List all available analytical datasets within a specific asset. Discovers analytical models that can be queried for business intelligence and reporting. Returns entity sets with their names, types, and URLs for data access.
| Name | Required | Description | Default |
|---|---|---|---|
| top | No | Maximum number of datasets to return (default: 50, max: 1000) | |
| skip | No | Number of datasets to skip for pagination | |
| asset_id | Yes | Asset identifier (e.g., 'SAP_SC_FI_AM_FINTRANSACTIONS') | |
| space_id | Yes | Space identifier (e.g., 'SAP_CONTENT') |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must carry the burden. It states the tool lists and returns data, implying a read-only operation, but does not disclose any behavioral traits such as permission requirements, rate limits, or side effects. For a simple list tool, this is adequate but not fully transparent.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences, front-loaded with the main purpose, and each sentence adds value: first sentence states the action, second sentence elaborates on return details. No superfluous content.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the lack of output schema, the description partially explains return values (names, types, URLs). It does not cover pagination or error conditions, but for a list tool with well-documented parameters, it is reasonably complete. Could be improved with usage guidance.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, with descriptions for space_id, asset_id, top, and skip. The description adds no additional meaning beyond the schema (e.g., 'within a specific asset' aligns with asset_id). Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool lists analytical datasets within a specific asset, distinguishing it from siblings like list_catalog_assets or get_analytical_metadata. The verb 'list' and resource 'analytical datasets' are specific.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage when you need to discover analytical models for an asset, but it does not explicitly state when to use this tool versus alternatives like list_catalog_assets or query_analytical_data. No when-not-to-use guidance is provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_catalog_assetsA
Browse all data assets across all SAP Datasphere spaces.
Use this tool when:
User asks "What assets are available in Datasphere?"
Building a complete data catalog or asset inventory
Discovering available data assets across all spaces
Searching for specific asset types across the system
Understanding the overall data landscape
What you'll get:
Asset IDs and names across all spaces
Asset types (AnalyticalModel, View, Table)
Space information for each asset
Consumption URLs (analytical and relational)
Exposure status and metadata URLs
Creation and modification timestamps
Available parameters:
select_fields: Specific fields to return (e.g., ['name', 'description', 'spaceId'])
filter_expression: OData filter (e.g., "spaceId eq 'SAP_CONTENT'")
top: Maximum results (default 50, max 1000)
skip: Results to skip for pagination
include_count: Include total count of assets
Example queries:
"List all available assets in Datasphere"
"Show me all analytical models across all spaces"
"Find assets in the SAP_CONTENT space"
"List the first 20 assets with their consumption URLs"
Common filters:
By space:
filter_expression="spaceId eq 'SAP_CONTENT'"By type:
filter_expression="assetType eq 'AnalyticalModel'"Exposed only:
filter_expression="exposedForConsumption eq true"Combined:
filter_expression="spaceId eq 'SALES' and assetType eq 'View'"
Asset types you'll see:
AnalyticalModel: Multi-dimensional models for analytics
View: SQL views combining multiple data sources
Table: Physical tables with business data
Fact: Fact tables in analytical models
Dimension: Dimension tables in analytical models
Note: This uses the Catalog API: GET /api/v1/datasphere/consumption/catalog/assets
| Name | Required | Description | Default |
|---|---|---|---|
| top | No | Maximum number of results to return (default: 50, max: 1000). | |
| skip | No | Number of results to skip for pagination (default: 0). | |
| include_count | No | Include total count of matching assets (default: false). | |
| select_fields | No | Specific fields to return (e.g., ['name', 'description', 'spaceId']). If not specified, returns all fields. | |
| filter_expression | No | OData filter expression (e.g., "spaceId eq 'SAP_CONTENT'" or "assetType eq 'AnalyticalModel'"). |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries full burden. It states the tool uses a GET API (read-only) and lists what will be returned. It does not explicitly mention side effects, but 'browse' implies non-destructive. Adds context like asset types and fields returned, but could note limitations or auth needs.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with sections, bullet points, and examples. It front-loads the main purpose. However, it is somewhat lengthy and repeats asset types (once in a list and again later). Minor redundancy prevents a 5.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Despite lacking an output schema, the description compensates by detailing what will be returned (IDs, names, types, URLs, timestamps). It also covers usage scenarios, common filters, and provides example queries, making it complete for an asset listing tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline is 3. The description adds significant value by explaining each parameter with examples, defaults, and common filter expressions, such as default top 50, max 1000, and sample OData filters.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description explicitly states 'Browse all data assets across all SAP Datasphere spaces.' The verb 'browse/list', resource 'data assets', and scope 'all spaces' are clear. It distinguishes from siblings like 'get_space_assets' (space-specific) and 'search_catalog' (search vs list).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit when-to-use scenarios such as 'User asks "What assets are available in Datasphere?"' and 'Building a complete data catalog'. It includes example queries and common filters, giving clear context for usage.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_connectionsA
List all external data source connections and their current status.
Use this tool when:
User asks "What data sources are connected?"
Checking connection health and availability
Understanding data lineage and sources
Troubleshooting data refresh issues
What you'll get:
Connection IDs and names
Connection types (SAP_ERP, SALESFORCE, EXTERNAL, etc.)
Connection status (CONNECTED, DISCONNECTED, ERROR)
Host information and last tested timestamp
Supported connection types:
SAP_ERP, SAP_S4HANA, SAP_BW
SALESFORCE, EXTERNAL
SNOWFLAKE, DATABRICKS
POSTGRESQL, MYSQL, ORACLE, SQLSERVER, HANA
Example queries:
"What external connections exist?"
"Show me all SAP ERP connections"
"Check if Salesforce connection is active"
Use cases:
Data integration monitoring
Connection health checks
Understanding data sources
| Name | Required | Description | Default |
|---|---|---|---|
| connection_type | No | Optional: Filter by specific connection type (e.g., 'SAP_ERP', 'SALESFORCE', 'EXTERNAL'). Leave empty to show all connections. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description must disclose behavioral traits fully. It states the tool returns connection IDs, names, types, status (CONNECTED/DISCONNECTED/ERROR), host info, and last tested timestamp, establishing it as a read-only listing operation. No destructive behavior is implied. It could mention permissions or caching, but the current level is adequate.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with clear headings, bullet points, and sections (when to use, what you get, supported types, examples, use cases). Every section contributes meaningful information. While slightly lengthy, the organization ensures agents can quickly parse key details.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the lack of an output schema, the description fully explains the return fields (IDs, names, types, status, host, timestamp). The tool has low complexity (one optional parameter), and the description covers all necessary context for correct invocation and interpretation. No gaps remain.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema covers the single optional parameter with a description, achieving 100% coverage. The description adds value by listing supported connection types (SAP_ERP, SALESFORCE, etc.) and providing example queries that illustrate parameter usage, such as filtering by 'SAP_ERP' or 'SALESFORCE'. This enriches the schema's meaning.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly defines the tool as listing external data source connections and their status. It distinguishes itself from siblings like 'test_connection' by focusing on listing rather than testing individual connections. The verb 'list' and resource 'connections' are specific and unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit guidance on when to use the tool, including common user queries and troubleshooting scenarios. It implicitly suggests using 'test_connection' for testing individual connections, but lacks an explicit 'when not to use' statement. Nonetheless, the usage scenarios are clear and practical.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_database_usersA
List all database users in a specific SAP Datasphere space.
Use this tool when:
User asks "What database users exist in SALES space?"
Auditing user access and permissions
Checking who has database access to a space
Before creating a new database user (avoid duplicates)
What you'll get:
Database user IDs and full names
User status (ACTIVE, INACTIVE)
Access permissions and privileges
Last login information
Audit policy settings
Required parameter:
space_id: The space ID (uppercase, e.g., 'SALES', 'FINANCE')
Example queries:
"List all database users in SALES space"
"Show me who has database access to FINANCE"
"What database users are configured?"
Database user access types:
Consumption: Read data with/without grant privileges
Ingestion: Write/load data into space
Schema access: Local and space schema access
Script server: Execute advanced analytics
Note: This corresponds to the CLI command: datasphere dbusers list --space
| Name | Required | Description | Default |
|---|---|---|---|
| space_id | Yes | The space ID in UPPERCASE format (e.g., 'SALES', 'FINANCE', 'HR'). Must match exactly. | |
| output_file | No | Optional: Path to save output as JSON file (e.g., 'users.json'). If not provided, results display in response. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must carry the full burden. It lists what you get (user IDs, status, etc.) but does not explicitly state read-only nature, authentication requirements, or error handling. Some behavioral context is implied but not confirmed.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with clear sections (overview, when to use, what you'll get, required parameter, examples). It is front-loaded with the purpose. Slightly verbose with access types and CLI note, but each section adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no output schema, the description explains the return fields (IDs, names, status, etc.). Input schema is fully covered. Missing details like pagination or error cases, but adequate for a list tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, but the description adds value by specifying the format for space_id (uppercase) and providing examples. The optional output_file parameter is also explained. This goes beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'List all database users in a specific SAP Datasphere space' with a specific verb and resource. It distinguishes from sibling tools like create_database_user and delete_database_user.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicit use cases are provided (e.g., 'User asks What database users exist in SALES space?') along with example queries. While it doesn't explicitly state when not to use, it clearly implies alternatives exist.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_relational_entitiesA
List all available relational entities (tables/views) within a specific SAP Datasphere asset for row-level data access and ETL operations. Returns OData entity sets that can be queried for detailed data extraction.
| Name | Required | Description | Default |
|---|---|---|---|
| top | No | Maximum number of entities to return (default: 50, max: 1000) | |
| asset_id | Yes | Asset identifier (e.g., 'SAP_SC_FI_AM_FINTRANSACTIONS') | |
| space_id | Yes | Space identifier (e.g., 'SAP_CONTENT') |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must carry the full burden. It implies read-only behavior by stating 'list' and 'returns', but does not explicitly confirm non-destructiveness or mention authentication needs, rate limits, or side effects. The disclosure is adequate but not thorough.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, front-loaded with the core action and resource, then clarifying the return type. Every word serves a purpose with no redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description explains the return (OData entity sets) and connects to broader workflow (ETL operations). Without an output schema, it provides sufficient context for a list operation. Could be more complete by explicitly noting that it is the starting point for subsequent queries.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, providing clear descriptions for all three parameters. The description adds contextual purpose but no additional meaning beyond what the schema offers. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'List' and the resource 'relational entities (tables/views) within a specific SAP Datasphere asset'. It distinguishes from siblings by specifying the scope (all entities in an asset) and the purpose (row-level data access and ETL operations), which is distinct from tools like get_relational_entity_metadata or query_relational_entity.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage for discovery before querying detailed data, but does not explicitly state when not to use it or mention alternative tools. The context is clear but lacks exclusions or guidance on specific scenarios.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_spacesA
List all SAP Datasphere spaces with their status and metadata.
Use this tool when:
User asks "What spaces are available?" or "Show me all spaces"
You need to discover available Datasphere environments
Starting data exploration workflow
Checking space status and availability
What you'll get:
Space IDs and names
Space status (ACTIVE, DEVELOPMENT, etc.)
Table/view counts per space
Owner information (with include_details=True)
Example queries:
"What Datasphere spaces exist?"
"Show me all data spaces"
"Which spaces are active?"
Next steps after using this tool:
Use get_space_info() to explore a specific space
Use search_tables() to find tables across spaces
| Name | Required | Description | Default |
|---|---|---|---|
| include_details | No | Set to true to include detailed information (owner, created date, connection counts). Default: false for quick space listing. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, description carries full burden. It explains what fields are returned (IDs, names, status, counts) and conditionally owner details. It implies read-only behavior but doesn't explicitly state no side effects. Reasonably transparent for a listing tool.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Well-structured with markdown sections, bullet points, and concise sentences. Every section adds value: purpose, usage conditions, output description, example queries, and next steps. No fluff.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given one optional parameter and no output schema, the description is comprehensive. It covers what to expect in results and suggests follow-up actions. Sibling tools are not needed for completeness of this tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline is 3. Description adds value by explaining the parameter's effect (include_details adds owner, dates, connection counts) and default behavior. Goes beyond schema to clarify practical usage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description explicitly states 'List all SAP Datasphere spaces with their status and metadata.' It specifies the resource (spaces), action (list), and output elements (status, metadata). It distinguishes from sibling tools like get_space_info by positioning it as a next step.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides clear 'Use this tool when:' section with specific scenarios (e.g., user asks about spaces, starting exploration, checking status). Also includes 'Next steps' suggesting get_space_info for further details. However, does not explicitly state when not to use or compare with other list tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
query_analytical_dataA
Execute OData queries on analytical models to retrieve aggregated data with dimensions and measures. Supports full OData query syntax: $select (column selection), $filter (WHERE conditions), $orderby (sorting), $top/$skip (pagination), $apply (aggregations with sum/average/min/max/count/groupby). Perfect for business intelligence, reporting, and data analysis.
| Name | Required | Description | Default |
|---|---|---|---|
| top | No | Maximum number of results (default: 50, max: 10000) | |
| skip | No | Number of results to skip for pagination | |
| apply | No | Aggregation transformations (e.g., 'groupby((Currency), aggregate(Amount with sum as TotalAmount))') | |
| count | No | Report a row count. Analytical entities declare Countable:false, so $count is not sent -- the count returned covers the current page only. | |
| filter | No | OData $filter. Operators: eq ne gt ge lt le, and/or/not, (). Partial text matching: startswith(Field,'v'), endswith(Field,'v'), contains(Field,'v') -- text columns only. Values must be single-quoted and are CASE-SENSITIVE ('us' does not match 'US'). A value containing a single quote cannot be filtered on at all. Example: startswith(Product,'TV') and Country eq 'US'. Filtering a dimension is much cheaper than filtering an aggregated measure. Assets whose lineage includes federated sources accept only eq/and/or/(). | |
| select | No | Comma-separated list of dimensions/measures to return (OData $select) | |
| orderby | No | Sort order (e.g., 'Amount desc, TransactionDate asc') | |
| asset_id | Yes | Asset identifier | |
| space_id | Yes | Space identifier | |
| entity_set | Yes | Entity set name to query |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations present, the description carries full responsibility for behavioral disclosure. It provides several non-obvious behavioral details: filtering dimensions is cheaper than filtering measures, federated sources support only eq/and/or/(), values must be single-quoted and are case-sensitive, and a value containing a single quote cannot be filtered on. This goes well beyond the schema and informs the agent of important limitations and performance characteristics.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences and front-loaded with the primary action. The second sentence compactly lists all supported OData clauses in a single line, and the third clause adds clear use cases. No word is wasted, and the structure makes the tool's capability immediately apparent.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Despite lacking an output schema, the description provides a comprehensive view of what the tool does, its supported syntax, and its intended use cases. The rich param schema covers the individual parameters, while the description supplies the overarching query context and behavioral caveats. For a query tool of this complexity, the combination is sufficiently complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description adds a high-level overview of OData syntax but does not add significant per-parameter meaning beyond what the schema already explains. The schema's parameter descriptions already cover examples, defaults, and constraints, so the tool description's additional value is marginal.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose: executing OData queries on analytical models to retrieve aggregated data. It names the supported query capabilities ($select, $filter, $orderby, $top/$skip, $apply), making it distinct from sibling tools like query_relational_entity or execute_query. The resource (analytical models) and action (execute/retrieve) are specific and unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description indicates when to use the tool ('Perfect for business intelligence, reporting, and data analysis') and defines its domain as analytical models. It does not explicitly name alternatives or state when not to use it, but the analytical/OData focus provides clear contextual guidance versus relational query tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
query_relational_entityA
Execute OData queries on relational entities for ETL data extraction. Supports large batch processing (up to 50,000 records), advanced filtering, column selection, and pagination. Optimized for data warehouse loading and analytics pipelines. Use list_relational_entities to discover available entity names first.
| Name | Required | Description | Default |
|---|---|---|---|
| top | No | Maximum records to return (default: 1000, max: 50000 for ETL) | |
| skip | No | Number of records to skip for pagination | |
| filter | No | OData $filter. Operators: eq ne gt ge lt le, and/or/not, (). Partial text matching: startswith(Field,'v'), endswith(Field,'v'), contains(Field,'v') -- text columns only. Values must be single-quoted and are CASE-SENSITIVE ('us' does not match 'US'). A value containing a single quote cannot be filtered on at all. Example: startswith(Product,'TV') and Country eq 'US'. Assets whose lineage includes federated sources accept only eq/and/or/(). | |
| select | No | Comma-separated column list for $select (e.g., "customer_id,amount,date") | |
| orderby | No | OData $orderby expression (e.g., "amount desc, date asc") | |
| asset_id | Yes | Asset identifier - same as used in list_relational_entities (e.g., 'SAP_SC_FI_AM_FINTRANSACTIONS') | |
| space_id | Yes | Space identifier (e.g., 'SAP_CONTENT') | |
| entity_name | Yes | Entity name from the OData service (e.g., 'Results', 'Data'). Use list_relational_entities to get available entity names. If unsure, try using the asset_id as entity_name. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the burden of behavioral disclosure. It mentions large batch processing (up to 50,000 records), filtering, column selection, and pagination, but does not disclose side effects, permissions, rate limits, or error behavior. The read-only nature is implied but not stated explicitly.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is conciseâfour sentences that front-load the core purpose and key capabilities. Every sentence provides useful information: what it does, batch limit, feature set, usage context, and a prerequisite tip. There is no redundancy or fluff.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool has 8 parameters and no output schema, the description competently covers the main usage context, capabilities, and a prerequisite step. It lacks explicit details about return value structure, but the absence of an output schema and the straightforward 'query' semantics mitigate this. The description is reasonably complete for a developer to start using the tool effectively.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema covers 100% of parameters with detailed descriptions, so the baseline is 3. The description adds no significant parameter-level detail beyond what the schema already provides; it only refers generally to filtering, column selection, and pagination, which are already documented in the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description begins with a specific verb phrase 'Execute OData queries' and clearly identifies the resource as 'relational entities', immediately distinguishing this tool from analytical query tools. It further specifies the ETL context and explicitly references sibling tool list_relational_entities, making the purpose unmistakable.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives clear context for when to use this tool (ETL data extraction, data warehouse loading, analytics pipelines) and instructs users to call list_relational_entities first. However, it does not explicitly state when not to use it or name alternative query tools, leaving some ambiguity versus query_analytical_data or execute_query.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
reset_database_user_passwordA
Reset the password for an existing database user in SAP Datasphere.
IMPORTANT: This is a HIGH-RISK tool that requires user consent before execution.
Use this tool when:
User requests "Reset password for database user JEFF"
Password forgotten or compromised
Regular password rotation policy
Account locked due to failed login attempts
What happens:
Old password is invalidated immediately
New password is auto-generated securely
User must change password on next login
Action is logged for security audit
Required parameters:
space_id: The space containing the database user
database_user_id: The user whose password needs reset
Security considerations:
New password shown only once - save securely!
Recommend using output_file to save credentials
Notify user through secure channel
Enforce password change on first login
All active sessions are terminated
Example queries:
"Reset password for JEFF in SALES space"
"Generate new password for database user ANALYST"
"REPORTING_USER password expired, reset it"
Best practices:
Always save output to secure file
Communicate new password via secure channel (not email!)
Verify user identity before resetting
Document password reset in change log
Note: Corresponds to CLI: datasphere dbusers password reset --space --databaseuser
| Name | Required | Description | Default |
|---|---|---|---|
| space_id | Yes | The space ID containing the database user (e.g., 'SALES', 'FINANCE'). Must be uppercase. | |
| output_file | No | Optional: Path to save new credentials JSON (e.g., 'jeff_new.json'). HIGHLY RECOMMENDED for security! | |
| database_user_id | Yes | Database user name suffix whose password will be reset (e.g., 'JEFF', 'ANALYST'). |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description fully discloses impacts: old password invalidated immediately, new password auto-generated, user must change on next login, sessions terminated, action logged. This exceeds typical transparency.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Well-structured with sections, front-loaded key sentence, and appropriate detail for a high-risk tool. While slightly verbose with examples and best practices, every section adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
No output schema, but description fully explains behavior (invalidation, auto-generation, forced change, termination, logging) and security considerations. Complete for the intended action.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with descriptions for all parameters. The description restates required params with context and highlights output_file security, but adds minimal value beyond the schema. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Reset the password for an existing database user in SAP Datasphere.' This verb+resource specification is precise and distinguishes the tool from siblings like create_database_user, delete_database_user, and update_database_user.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly lists scenarios for use (password forgotten, rotation, locked account) and includes security warnings. However, it does not explicitly contrast with sibling tool update_database_user or provide negative usage examples.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
run_task_chainA
Execute a task chain in SAP Datasphere and get a log ID for tracking.
Use this tool when:
User asks to "Run the ETL pipeline" or "Execute task chain X"
Triggering scheduled data loads or transformations
Starting data replication or synchronization jobs
Automating data refresh workflows
Executing orchestrated data pipelines
What happens:
Task chain execution is initiated immediately
Returns a logId to track the execution status
Task runs asynchronously (use get_task_log to check status)
All child tasks in the chain are executed in order
Required parameters:
space_id: The space containing the task chain (e.g., 'SALES_SPACE')
object_id: The task chain name/ID (e.g., 'Daily_ETL_Pipeline')
What you'll get:
logId: Unique identifier to track this execution
Use get_task_log(space_id, logId) to monitor progress
Use get_task_history(space_id, object_id) to see all runs
Example queries:
"Run the Daily_ETL_Pipeline in SALES_SPACE"
"Execute task chain Customer_Sync in FINANCE_SPACE"
"Trigger the data refresh pipeline in ANALYTICS"
"Start the nightly batch job in DWH_SPACE"
Important notes:
Task chains run asynchronously - tool returns immediately
Check status with get_task_log using the returned logId
Requires appropriate permissions to run task chains
Failed runs can be investigated with detailed logs
Workflow example:
Run task chain: run_task_chain(space_id='SALES', object_id='Daily_ETL')
Get logId from response (e.g., 2295172)
Check status: get_task_log(space_id='SALES', log_id=2295172)
View details: get_task_log(space_id='SALES', log_id=2295172, detail_level='detailed')
Note: Uses API: POST /api/v1/datasphere/tasks/chains/{space_id}/run/{object_id}
| Name | Required | Description | Default |
|---|---|---|---|
| space_id | Yes | The space ID containing the task chain (e.g., 'SALES_SPACE', 'FINANCE'). Must be uppercase. | |
| object_id | Yes | The task chain name/identifier to execute (e.g., 'Daily_ETL_Pipeline', 'Customer_Sync'). |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, but description covers async execution, immediate return, required permissions, and how to track status. Includes a workflow example and notes on detailed logs.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Well-structured with sections and bullet points. Information is front-loaded with purpose. Slightly verbose but every sentence adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
No output schema, but description explains return value (logId) and how to use it. Covers workflow, example, and API endpoint. Complete for the tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and schema describes parameters. Description adds example values and notes about uppercase for space_id, but does not add significant new semantics beyond schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Clearly states it executes a task chain and returns a logId for tracking. Differentiates from sibling tools like get_task_log and get_task_history by explaining async behavior and how to use the logId.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly lists when to use (e.g., run ETL pipeline, trigger data loads) and implicitly when not to (e.g., for status checking use get_task_log). Provides workflow example and example queries.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
search_catalogA
Universal search across all catalog items in SAP Datasphere using advanced search syntax. Supports searching across KPIs, assets, spaces, models, views, and tables. Use SCOPE: prefix for targeted searches. Boolean operators (AND, OR, NOT) supported.
| Name | Required | Description | Default |
|---|---|---|---|
| top | No | Maximum number of results to return (default: 50, max: 500) | |
| skip | No | Number of results to skip for pagination (default: 0) | |
| query | Yes | Search query with optional SCOPE prefix. Format: 'SCOPE:<scope> <terms>'. Scopes: SearchAll, SearchKPIsAdmin, SearchAssets, SearchSpaces, SearchModels, SearchViews, SearchTables. Example: 'SCOPE:comsapcatalogsearchprivateSearchAll financial' | |
| facets | No | Comma-separated list of facets to include or 'all' for all facets. Example: 'objectType,spaceId' | |
| facet_limit | No | Maximum number of facet values to return per facet (default: 5) | |
| include_count | No | Include total count of matching results (default: false) | |
| include_why_found | No | Include explanation of why each result matched (default: false) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, and description does not disclose behavioral aspects like idempotency, side effects, or permissions. It only describes input syntax, not server behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two succinct sentences: first defines purpose, second adds essential syntax hints. No redundancy or filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Does not describe return format, pagination behavior, or how results are structured. Given complex optional parameters and no output schema, more detail is needed for complete understanding.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema covers all parameters with descriptions (100% coverage). Description adds minimal extra value (e.g., SCOPE prefix usage), but semantics are mostly captured in schema. Baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it is a universal search across all catalog items and lists specific item types (KPIs, assets, etc.). It distinguishes from sibling tools like search_tables by implying broader scope.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides guidance on using SCOPE prefix and Boolean operators for targeted searches. Lacks explicit when-not-to-use or alternatives, but context is clear enough for an AI agent to decide.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
search_tablesA
Search for tables and views across all Datasphere spaces by name or description.
Use this tool when:
User asks "Find tables with customer data"
Looking for tables containing specific keywords
Don't know exact table name but know the domain
Searching across multiple spaces
Search behavior:
Searches both table names and descriptions
Case-insensitive matching
Returns results from all spaces (or specific space if filtered)
Includes table metadata (type, columns, row counts)
Search tips:
Use domain keywords: "customer", "sales", "order", "finance"
Partial matches work: "cust" finds "CUSTOMER_DATA"
Filter by space_id to narrow results
Example queries:
"Find all tables related to customers"
"Search for sales order tables"
"Show me all tables with 'finance' in the name"
Next steps:
Use get_table_schema() for detailed column information
Use execute_query() to retrieve actual data
| Name | Required | Description | Default |
|---|---|---|---|
| space_id | No | Optional: Filter results to a specific space (e.g., 'SALES_ANALYTICS'). Leave empty to search all spaces. | |
| search_term | Yes | Keyword to search for in table names and descriptions (e.g., 'customer', 'sales', 'order'). Case-insensitive, partial matches work. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Without annotations, the description carries full burden. It explains search behavior (case-insensitive, across spaces, includes metadata), but omits limit on results, sorting, or performance characteristics.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Well-structured with sections (use cases, behavior, tips, examples). Slightly lengthy but every section adds value. Front-loaded with core purpose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no output schema, description explains return includes metadata. Provides next steps for further actions. Sufficient for agent to understand usage.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with good descriptions. The description adds search tips, partial match behavior, and example queries, enhancing understanding beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it searches tables and views by name or description across all Datasphere spaces. It provides specific examples and distinguishes from siblings like search_catalog.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicit when-to-use list with concrete user queries (e.g., 'Find tables with customer data'). Includes next steps and search tips, but lacks explicit when-not-to-use or comparison with siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
smart_queryA
đ SMART QUERY - Intelligent query router that automatically selects the best execution method for your query.
NEW in v1.0.5 - This is a composite tool combining execute_query, query_relational_entity, and query_analytical_data with intelligent routing and fallback logic.
Why use smart_query instead of individual query tools?
â Automatic routing to the most reliable method
â Fallback handling if primary method fails
â No need to understand different query methods
â Better error recovery and diagnostics
â Performance optimization based on query type
How it works:
Analyzes your query - Detects SQL syntax, aggregations, complexity
Routes intelligently - Chooses the best execution method:
Aggregations (SUM, COUNT, GROUP BY) â Analytical endpoint
Simple SELECT â Relational endpoint (most reliable)
Complex SQL â SQL parsing with OData conversion
Falls back gracefully - If primary method fails, tries alternatives
Returns detailed logs - Shows routing decisions and execution path
Query Modes:
auto(default) - Intelligent routing based on query analysisrelational- Force use of relational endpoint (most reliable)analytical- Force use of analytical endpoint (for aggregations)sql- Force use of SQL parsing method
Use this tool when:
You want reliable query execution without worrying about method selection
You're unsure which query method to use
You need fallback handling for production reliability
You want to see execution diagnostics
Supported query patterns:
Simple SELECT:
SELECT * FROM SAP_SC_FI_V_ProductsDim LIMIT 10Filtering:
SELECT * FROM table WHERE PRICE > 1000Column selection:
SELECT PRODUCTID, PRICE FROM tableAggregations:
SELECT COMPANYNAME, SUM(GROSSAMOUNT) FROM table GROUP BY COMPANYNAMESorting:
SELECT * FROM table ORDER BY PRICE DESC LIMIT 5
Parameters:
space_id- Space ID (e.g., "SAP_CONTENT")query- SQL query or natural language requestmode- Routing mode: "auto", "relational", "analytical", "sql" (default: "auto")limit- Max rows to return (default: 1000)include_metadata- Include routing logs and decisions (default: true)fallback- Enable fallback to alternative methods (default: true)
Example queries:
# Auto-routing - simple SELECT
smart_query(space_id="SAP_CONTENT", query="SELECT * FROM SAP_SC_FI_V_ProductsDim LIMIT 5")
# Auto-routing - aggregation
smart_query(space_id="SAP_CONTENT", query="SELECT COMPANYNAME, SUM(GROSSAMOUNT) FROM SAP_SC_SALES_V_SalesOrders GROUP BY COMPANYNAME")
# Force relational mode
smart_query(space_id="SAP_CONTENT", query="SELECT * FROM SAP_SC_FI_V_ProductsDim", mode="relational")
# Disable fallback (fail fast)
smart_query(space_id="SAP_CONTENT", query="SELECT * FROM table", fallback=False)Response includes:
Query results (data)
Method used (relational, analytical, sql, or fallback)
Execution time
Rows returned
Routing decision log (if include_metadata=true)
Detected query characteristics
Error handling:
If primary method fails, automatically tries fallbacks
Returns detailed error log showing all attempted methods
Provides suggestions for fixing query issues
Shows routing decisions for debugging
Performance:
Relational: 1-5 seconds, up to 50K records
Analytical: Fast for aggregations
SQL: 1-5 seconds, up to 1K records
When to use individual tools instead:
Use
query_relational_entitywhen you need specific entity_name controlUse
query_analytical_datawhen you know you need analytical consumptionUse
execute_querywhen you need exact SQL syntax controlUse
smart_queryfor everything else (recommended for most use cases)
Note: This tool provides the same functionality as the individual query tools but with better reliability through intelligent routing and fallback handling.
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | Query execution mode. Use 'auto' for intelligent routing (recommended). Default: 'auto' | auto |
| limit | No | Maximum number of rows to return. Default: 1000. Range: 1-50000 | |
| query | Yes | SQL query to execute. Examples: 'SELECT * FROM table LIMIT 10', 'SELECT col1, SUM(col2) FROM table GROUP BY col1' | |
| fallback | No | Enable fallback to alternative query methods if primary fails. Default: true | |
| space_id | Yes | The Datasphere space ID (e.g., 'SAP_CONTENT', 'SALES'). Must match existing space. | |
| include_metadata | No | Include execution logs and routing decisions in response. Useful for debugging. Default: true |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description carries full burden. Details internal routing logic, fallback behavior, performance characteristics, error handling, and response structure. Describes how it analyzes queries and chooses methods.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Well-structured with headers, lists, and examples. Front-loaded with main purpose. Slightly verbose with some redundant explanations, but still efficient for a composite tool of this complexity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (composite, routing, fallback) and lack of output schema, description is exhaustive. Covers usage, behavior, parameters, examples, performance, error handling, and sibling differentiation. Provides everything an agent needs.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema covers all parameters (100%), but description adds substantial value: explains mode options with examples, provides query patterns, shows parameter usage in examples, and clarifies default values and ranges.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Clearly states it is an intelligent query router that combines multiple methods. Differentiates itself from siblings by being a composite tool with automatic routing and fallback. Uses specific verbs and resources.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly provides when to use smart_query vs individual tools, including conditions and alternatives. Contains sections 'Use this tool when' and 'When to use individual tools instead'.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
test_connectionA
Test the connection to SAP Datasphere and verify OAuth authentication status. Use this tool to check if the MCP server can successfully connect to SAP Datasphere.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, description carries the burden. It describes the purpose but lacks details on side effects (none expected), response format, or error conditions, which would improve transparency.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences directly state purpose and usage, no wasted words. Front-loaded with key action.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's simplicity (no parameters, no output schema), the description is complete enough for an agent to understand when and why to use it.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
No parameters exist, and schema coverage is 100%. Description adds no extra parameter info, but baseline 4 is appropriate due to zero parameters.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Clearly states the tool tests connection and OAuth authentication status. Distinguishes from sibling tools as none are dedicated health checks.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly says 'Use this tool to check if the MCP server can successfully connect', providing clear when-to-use guidance, though no alternatives or exclusions are mentioned.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
update_database_userA
Update permissions and configuration for an existing database user.
IMPORTANT: This is a HIGH-RISK tool that requires user consent before execution.
Use this tool when:
User requests "Grant schema access to JEFF in SALES"
Modifying user permissions or access levels
Enabling/disabling audit policies
Changing retention periods
Updating user privileges
What you can update:
Consumption permissions (read access, grants)
Schema access (space, local, HDI)
Script server access
Audit policies and retention periods
Password policies
Required parameters:
space_id: The space containing the database user
database_user_id: The user to update
updated_definition: JSON with new configuration (full definition required)
Update examples:
Grant schema access:
{
"consumption": {
"spaceSchemaAccess": true,
"consumptionWithGrant": false,
...
},
"ingestion": {...}
}Enable audit logging:
{
"consumption": {...},
"ingestion": {
"auditing": {
"dppRead": {
"isAuditPolicyActive": true,
"retentionPeriod": 90
}
}
}
}Important notes:
Must provide complete user definition (not partial updates)
Changes take effect immediately
Active sessions may need reconnection
All changes are logged for audit
Example queries:
"Grant space schema access to JEFF"
"Enable audit logging for ANALYST with 90 day retention"
"Update REPORTING_USER to have consumption with grant"
Note: Corresponds to CLI: datasphere dbusers update --space --databaseuser --file-path <def.json>
| Name | Required | Description | Default |
|---|---|---|---|
| space_id | Yes | The space ID containing the database user (e.g., 'SALES', 'FINANCE'). Must be uppercase. | |
| output_file | No | Optional: Path to save updated configuration JSON (e.g., 'jeff_updated.json'). | |
| database_user_id | Yes | Database user name suffix to update (e.g., 'JEFF', 'ANALYST'). | |
| updated_definition | Yes | Complete JSON object with updated permissions. Must include all settings (consumption, ingestion). |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description fully carries the burden. It explicitly labels the tool as 'HIGH-RISK' requiring user consent, and details behavioral traits: changes take effect immediately, active sessions may need reconnection, all changes are logged, and full definition required (no partial updates). No contradictions.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with sections, bullet points, and examples. It is front-loaded with the important risk warning. However, it is somewhat lengthy due to multiple examples; could be slightly more concise without losing clarity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the complexity (4 params, nested objects, no output schema), the description is highly complete. It covers all param semantics, use cases, behavioral notes, and update examples. It addresses missing schema details like audit policy and retention periods. No gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, baseline 3. The description adds significant value by explaining each parameter's purpose, providing JSON examples for updated_definition, and noting the full definition requirement. It also introduces the optional output_file parameter with usage example.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Update permissions and configuration for an existing database user.' It uses a specific verb ('update') and resource ('database user'), and distinguishes from sibling tools like create_database_user and delete_database_user by focusing on modification.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly provides 'Use this tool when:' scenarios such as granting schema access or modifying permissions, and implies when not to use by contrasting with create/delete/reset siblings. It includes concrete examples of user queries, offering clear guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections. Dates show when Glama detected each change.
2 tool updates
v1.6.0- Changed
query_analytical_data2 fields changed- changed
Input schema / properties / count / descriptionPrevious value: -"Include total count in response"New value: +"Report a row count. Analytical entities declare Countable:false, so $count is not sent -- the count returned covers the current page only." - changed
Input schema / properties / filter / descriptionPrevious value: -"OData filter expression (e.g., 'Amount gt 1000 and Currency eq \"USD\"')"New value: +"OData $filter. Operators: eq ne gt ge lt le, and/or/not, (). Partial text matching: startswith(Field,'v'), endswith(Field,'v'), contains(Field,'v') -- text columns only. Values must be single-quoted and are CASE-SENSITIVE ('us' does not match 'US'). A value containing a single quote cannot be filtered on at all. Example: startswith(Product,'TV') and Country eq 'US'. Filtering a dimension is much cheaper than filtering an aggregated measure. Assets whose lineage includes federated sources accept only eq/and/or/()."
- Changed
query_relational_entity1 field changed- changed
Input schema / properties / filter / descriptionPrevious value: -"OData $filter expression (e.g., \"amount gt 1000 and status eq 'ACTIVE'\")"New value: +"OData $filter. Operators: eq ne gt ge lt le, and/or/not, (). Partial text matching: startswith(Field,'v'), endswith(Field,'v'), contains(Field,'v') -- text columns only. Values must be single-quoted and are CASE-SENSITIVE ('us' does not match 'US'). A value containing a single quote cannot be filtered on at all. Example: startswith(Product,'TV') and Country eq 'US'. Assets whose lineage includes federated sources accept only eq/and/or/()."
39 tool updates
v1.4.0- First observed
analyze_column_distribution - First observed
browse_marketplace - First observed
create_database_user - First observed
delete_database_user - First observed
execute_query - First observed
find_assets_by_column - First observed
get_analytical_metadata - First observed
get_analytical_model - First observed
get_asset_by_compound_key - First observed
get_asset_details - First observed
get_asset_variables - First observed
get_available_scopes - First observed
get_current_user - First observed
get_deployed_objects - First observed
get_object_definition - First observed
get_relational_entity_metadata - First observed
get_relational_metadata - First observed
get_space_assets - First observed
get_space_info - First observed
get_table_schema - First observed
get_task_history - First observed
get_task_log - First observed
get_task_status - First observed
get_tenant_info - First observed
list_analytical_datasets - First observed
list_catalog_assets - First observed
list_connections - First observed
list_database_users - First observed
list_relational_entities - First observed
list_spaces - First observed
query_analytical_data - First observed
query_relational_entity - First observed
reset_database_user_password - First observed
run_task_chain - First observed
search_catalog - First observed
search_tables - First observed
smart_query - First observed
test_connection - First observed
update_database_user
TDQS
Most tools have clearly distinct purposes, but there is overlap among metadata retrieval tools (get_asset_details, get_analytical_metadata, get_analytical_model, etc.) and query tools (execute_query, query_analytical_data, query_relational_entity, smart_query), which could confuse an agent. However, descriptions help differentiate.
All tools follow a consistent snake_case verb_noun pattern (e.g., list_spaces, get_asset_details, create_database_user). No mixing of conventions, making it predictable.
39 tools is on the high side for a single server. While each tool serves a distinct purpose in managing a data platform, the count borders on excessive and could benefit from splitting into smaller, focused sub-servers.
The tool set covers major areas like catalog browsing, querying, user management, and task chains. However, missing create/update/delete for spaces and assets, and no data import tools, leaving notable gaps for a comprehensive data platform.
Maintenance
Resources
Unclaimed servers have limited discoverability.
Looking for Admin?
If you are the server author, to access and configure the admin panel.
Related MCP Connectors
Cloud-hosted MCP server for secure AI access to enterprise data sources via CData Connect AI.
MCP server unifying ERPs, CRMs, APIs and knowledge base for Claude, ChatGPT and Gemini.
MCP server that lets AI assistants use all OneSchema features exposed via the public API.
Governed data discovery, exact queries, decisions, simulations, and runtime utilities over MCP.
Related MCP Servers
- AlicenseNot gradedqualityDmaintenanceA config-driven MCP server that exposes OData and REST APIs as MCP tools, enabling AI assistants to query, manage, and monitor SAP backends through natural language.7928MIT
- AlicenseNot gradedqualityCmaintenanceProduction-ready MCP server enabling AI assistants to interact with SAP Datasphere for real tenant data discovery, metadata exploration, analytics operations, ETL data extraction, database user management, data lineage analysis, and column-level data profiling.MIT
- AlicenseAqualityDmaintenanceMCP server for SAP Analytics Cloud, enabling AI assistants to interact with SAC stories, models, data, users, and audit logs via the SAC REST API.34ISC
- AlicenseAqualityBmaintenanceModel Context Protocol server that lets AI assistants explore and query SAP Datasphere â metadata discovery, catalog search, OData and SQL queries, ETL extraction, data lineage and column profiling â with built-in config-driven PII masking.42771MIT
Latest Blog Posts
- Who's Calling? MCP Hosts Are an Identity Blind Spot (And the Spec Knows It)By Om-Shree-0709 on .mcpAgent IdentityOAuth 2.1
- Your AI Chatbot Just Exposed Your CEO's Salary to an InternBy Om-Shree-0709 on .Agent IdentityMCP SecurityOAuth Delegation
- Why MCP Servers Need Execution Sandboxing (And Why Your Current Stack Isn't Enough)By Om-Shree-0709 on .Agentic AiPrompt InjectionWebAssembly
MCP directory API
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/MarioDeFelipe/sap-datasphere-mcp'
If you have feedback or need assistance with the MCP directory API, please join our Discord server