Skip to content

Update read metadata schemas #133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Oct 21, 2025
Merged

Update read metadata schemas #133

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8a468ab
support parameters and new properties for getMetadata tool.
stephendeoca Oct 20, 2025
2764c68
Update getDatasourceMetadata tests
stephendeoca Oct 20, 2025
ee58efb
update minor version
stephendeoca Oct 20, 2025
d283272
Update docs
stephendeoca Oct 20, 2025
cfb7fe2
update null schemas
stephendeoca Oct 21, 2025
57692cc
Merge branch 'main' into update-metadata-schemas
stephendeoca Oct 21, 2025
32d1619
Update patch version
stephendeoca Oct 21, 2025
5e101f0
update null schemas
stephendeoca Oct 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 45 additions & 3 deletions docs/docs/tools/data-qna/get-datasource-metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,27 +32,31 @@ Example: `2d935df8-fe7e-4fd8-bb14-35eb4ba31d45`
{
"name": "Returned",
"dataType": "STRING",
"columnClass": "COLUMN",
"defaultAggregation": "COUNT",
"dataCategory": "NOMINAL",
"role": "DIMENSION"
},
{
"name": "Category",
"dataType": "STRING",
"columnClass": "COLUMN",
"defaultAggregation": "COUNT",
"dataCategory": "NOMINAL",
"role": "DIMENSION"
},
{
"name": "Discount",
"dataType": "REAL",
"columnClass": "COLUMN",
"defaultAggregation": "SUM",
"dataCategory": "QUANTITATIVE",
"role": "MEASURE"
},
{
"name": "Postal Code",
"dataType": "STRING",
"columnClass": "COLUMN",
"defaultAggregation": "COUNT",
"dataCategory": "ORDINAL",
"role": "DIMENSION",
Expand All @@ -66,133 +70,171 @@ Example: `2d935df8-fe7e-4fd8-bb14-35eb4ba31d45`
{
"name": "Order ID",
"dataType": "STRING",
"columnClass": "COLUMN",
"defaultAggregation": "COUNT",
"dataCategory": "NOMINAL",
"role": "DIMENSION"
},
{
"name": "Product Name",
"dataType": "STRING",
"columnClass": "COLUMN",
"defaultAggregation": "COUNT",
"dataCategory": "NOMINAL",
"role": "DIMENSION"
},
{
"name": "Ship Date",
"dataType": "DATE",
"columnClass": "COLUMN",
"defaultAggregation": "YEAR",
"dataCategory": "ORDINAL",
"role": "DIMENSION"
},
{
"name": "Quantity",
"dataType": "INTEGER",
"columnClass": "COLUMN",
"defaultAggregation": "SUM",
"dataCategory": "QUANTITATIVE",
"role": "MEASURE"
},
{
"name": "City",
"dataType": "STRING",
"columnClass": "COLUMN",
"defaultAggregation": "COUNT",
"dataCategory": "NOMINAL",
"role": "DIMENSION"
},
{
"name": "Sub-Category",
"dataType": "STRING",
"columnClass": "COLUMN",
"defaultAggregation": "COUNT",
"dataCategory": "NOMINAL",
"role": "DIMENSION"
},
{
"name": "Profit (bin)",
"dataType": "INTEGER",
"columnClass": "BIN",
"defaultAggregation": "NONE",
"formula": "[Profit]",
"dataCategory": "ORDINAL",
"role": "DIMENSION",
"formula": "[Profit]"
"role": "DIMENSION"
},
{
"name": "Segment",
"dataType": "STRING",
"columnClass": "COLUMN",
"defaultAggregation": "COUNT",
"dataCategory": "NOMINAL",
"role": "DIMENSION"
},
{
"name": "State/Province",
"dataType": "STRING",
"columnClass": "COLUMN",
"defaultAggregation": "COUNT",
"dataCategory": "NOMINAL",
"role": "DIMENSION"
},
{
"name": "Sales",
"dataType": "REAL",
"columnClass": "COLUMN",
"defaultAggregation": "SUM",
"dataCategory": "QUANTITATIVE",
"role": "MEASURE"
},
{
"name": "Manufacturer",
"dataType": "STRING",
"columnClass": "GROUP",
"defaultAggregation": "COUNT",
"dataCategory": "NOMINAL",
"role": "DIMENSION"
},
{
"name": "Region",
"dataType": "STRING",
"columnClass": "COLUMN",
"defaultAggregation": "COUNT",
"dataCategory": "NOMINAL",
"role": "DIMENSION"
},
{
"name": "Ship Mode",
"dataType": "STRING",
"columnClass": "COLUMN",
"defaultAggregation": "COUNT",
"dataCategory": "NOMINAL",
"role": "DIMENSION"
},
{
"name": "Order Date",
"dataType": "DATE",
"columnClass": "COLUMN",
"defaultAggregation": "YEAR",
"dataCategory": "ORDINAL",
"role": "DIMENSION"
},
{
"name": "Profit",
"dataType": "REAL",
"columnClass": "COLUMN",
"defaultAggregation": "SUM",
"dataCategory": "QUANTITATIVE",
"role": "MEASURE"
},
{
"name": "Country/Region",
"dataType": "STRING",
"columnClass": "COLUMN",
"defaultAggregation": "COUNT",
"dataCategory": "NOMINAL",
"role": "DIMENSION"
},
{
"name": "Profit Ratio",
"dataType": "REAL",
"columnClass": "CALCULATION",
"defaultAggregation": "AGG",
"formula": "SUM([Profit])/SUM([Sales])",
"dataCategory": "QUANTITATIVE",
"role": "MEASURE",
"formula": "SUM([Profit])/SUM([Sales])",
"isAutoGenerated": false,
"hasUserReference": false
},
{
"name": "Customer Name",
"dataType": "STRING",
"columnClass": "COLUMN",
"defaultAggregation": "COUNT",
"dataCategory": "NOMINAL",
"role": "DIMENSION"
}
],
"parameters": [
{
"name": "Top Customers",
"parameterType": "QUANTITATIVE_RANGE",
"dataType": "INTEGER",
"value": 5,
"min": 5,
"max": 20,
"step": 5
},
{
"name": "Profit Bin Size",
"parameterType": "QUANTITATIVE_RANGE",
"dataType": "INTEGER",
"value": 200,
"min": 50,
"max": 200,
"step": 50
}
]
}
```
4 changes: 2 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@tableau/mcp-server",
"description": "An MCP server for Tableau, providing a suite of tools that will make it easier for developers to build AI applications that integrate with Tableau.",
"version": "1.10.0",
"version": "1.10.1",
"repository": {
"type": "git",
"url": "git+https://github.com/tableau/tableau-mcp.git"
Expand Down
44 changes: 22 additions & 22 deletions src/sdks/tableau/apis/metadataApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,47 +5,47 @@ export const graphqlResponse = z.object({
data: z.object({
publishedDatasources: z.array(
z.object({
name: z.string().or(z.null()),
description: z.string().or(z.null()),
name: z.string().nullable(),
description: z.string().nullable(),
owner: z.object({
name: z.string().or(z.null()),
name: z.string().nullable(),
}),
fields: z.array(
z.object({
name: z.string(),
isHidden: z.boolean().or(z.null()),
description: z.string().or(z.null()),
isHidden: z.boolean().nullable(),
description: z.string().nullable(),
descriptionInherited: z
.array(
z
.object({
attribute: z.string(),
value: z.string().or(z.null()),
value: z.string().nullable(),
})
.or(z.null()),
.nullable(),
)
.or(z.null()),
.nullable(),
fullyQualifiedName: z.string(),
__typename: z.string(),
// Common field properties (optional since they depend on field type)
dataCategory: z.string().or(z.null()).optional(),
role: z.string().or(z.null()).optional(),
dataType: z.string().or(z.null()).optional(),
defaultFormat: z.string().or(z.null()).optional(),
semanticRole: z.string().or(z.null()).optional(),
aggregation: z.string().or(z.null()).optional(),
aggregationParam: z.string().or(z.null()).optional(),
dataCategory: z.string().nullish(),
role: z.string().nullish(),
dataType: z.string().nullish(),
defaultFormat: z.string().nullish(),
semanticRole: z.string().nullish(),
aggregation: z.string().nullish(),
aggregationParam: z.string().nullish(),
// CalculatedField specific properties
formula: z.string().or(z.null()).optional(),
isAutoGenerated: z.boolean().or(z.null()).optional(),
hasUserReference: z.boolean().or(z.null()).optional(),
formula: z.string().nullish(),
isAutoGenerated: z.boolean().nullish(),
hasUserReference: z.boolean().nullish(),
// BinField specific properties
binSize: z.number().or(z.null()).optional(),
binSize: z.number().nullish(),
// GroupField specific properties
hasOther: z.boolean().or(z.null()).optional(),
hasOther: z.boolean().nullish(),
// CombinedSetField specific properties
delimiter: z.string().or(z.null()).optional(),
combinationType: z.string().or(z.null()).optional(),
delimiter: z.string().nullish(),
combinationType: z.string().nullish(),
}),
),
}),
Expand Down
63 changes: 52 additions & 11 deletions src/sdks/tableau/apis/vizqlDataServiceApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,29 +55,70 @@ export const Function = z.enum([
'UNSPECIFIED',
]);

const DataType = z.enum([
'INTEGER',
'REAL',
'STRING',
'DATETIME',
'BOOLEAN',
'DATE',
'SPATIAL',
'UNKNOWN',
]);

const PeriodType = z.enum(['MINUTES', 'HOURS', 'DAYS', 'WEEKS', 'MONTHS', 'QUARTERS', 'YEARS']);

const FieldMetadata = z
.object({
fieldName: z.string(),
fieldCaption: z.string(),
dataType: z.enum([
'INTEGER',
'REAL',
'STRING',
'DATETIME',
'BOOLEAN',
'DATE',
'SPATIAL',
'UNKNOWN',
]),
dataType: DataType,
defaultAggregation: Function,
columnClass: z.enum(['COLUMN', 'BIN', 'GROUP', 'CALCULATION', 'TABLE_CALCULATION']),
formula: z.string(),
logicalTableId: z.string(),
})
.partial()
.passthrough();

const ParameterValue = z.union([z.number(), z.string(), z.boolean(), z.null()]);

const ParameterBase = z.object({
parameterCaption: z.string(),
dataType: DataType.exclude(['DATETIME', 'SPATIAL', 'UNKNOWN']),
parameterName: z.string().optional(),
value: ParameterValue,
});

const Parameter = z.discriminatedUnion('parameterType', [
ParameterBase.extend({ parameterType: z.literal('ANY_VALUE') }).strict(),
ParameterBase.extend({
parameterType: z.literal('LIST'),
members: z.array(ParameterValue),
}).strict(),
ParameterBase.extend({
parameterType: z.literal('QUANTITATIVE_DATE'),
value: z.string().nullable(),
minDate: z.string().optional().nullable(),
maxDate: z.string().optional().nullable(),
periodValue: z.number().optional().nullable(),
periodType: PeriodType.optional().nullable(),
}).strict(),
ParameterBase.extend({
parameterType: z.literal('QUANTITATIVE_RANGE'),
value: z.number().nullable(),
min: z.number().optional().nullable(),
max: z.number().optional().nullable(),
step: z.number().optional().nullable(),
}).strict(),
]);

export const MetadataOutput = z
.object({
data: z.array(FieldMetadata),
extraData: z.object({
parameters: z.array(Parameter),
}),
})
.partial()
.passthrough();
Expand Down Expand Up @@ -138,7 +179,7 @@ export const SetFilter = SimpleFilterBase.extend({

const RelativeDateFilterBase = SimpleFilterBase.extend({
filterType: z.literal('DATE'),
periodType: z.enum(['MINUTES', 'HOURS', 'DAYS', 'WEEKS', 'MONTHS', 'QUARTERS', 'YEARS']),
periodType: PeriodType,
anchorDate: z.string().optional(),
includeNulls: z.boolean().optional(),
});
Expand Down
Loading