Skip to main content
Glama

datamodel.get_table_schema

datamodel_get_table_schema
Read-only

Retrieve a table's schema from a Sisense connection by providing connection, database, schema, and table names. Returns schema details or an error if not found.

Instructions

Retrieve the schema of a table within a connection's data source. Resolves the connection by name to obtain its oid and provider, then sends POST /api/v1/connection/{id}/table_schema_details. Returns: dict[str, Any] Table schema details if found, or {"error": "..."} on failure or when no schema is found. Note: This endpoint is undocumented and may change in future Sisense versions. Use with caution.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
table_nameYesName of the table (sent as ``table``).
schema_nameYesName of the schema (sent as ``schema``).
database_nameYesName of the database (sent as ``Database``).
connection_nameYesName of the connection.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.5/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations only declare readOnlyHint, openWorldHint, and destructiveHint. The description goes well beyond that by disclosing the POST endpoint, the connection resolution process, the exact return contract (dict or error), and a caution that the endpoint is undocumented and may change. This is substantial behavioral context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three sentences deliver purpose+mechanism, return value, and a risk warning with no filler. The key facts are front-loaded and every sentence earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description covers what the tool does, how it executes (connection resolution + POST), what it returns on success and failure, and a stability warning. With readOnly and non-destructive annotations covering the safety profile, nothing essential is missing for an agent to invoke it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema already documents all four parameters with descriptions and wire-name mappings, so schema coverage is 100%. The description adds no additional parameter-level meaning beyond the schema's own documentation, making baseline 3 appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with 'Retrieve the schema of a table within a connection's data source,' a specific verb+resource statement. It also names the exact API endpoint and scope, distinguishing it from sibling tools like datamodel_get_model_schema, which targets model-level schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context: this is for retrieving table schema from a connection's data source, and it explains the resolution flow via connection_name. However, it does not explicitly state when to prefer this over datamodel_get_model_schema or datamodel_describe_datamodel, nor does it mention exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.