Twilize
Server Details
Generate Tableau .twb/.twbx workbooks: 47 tools for charts, dashboards, rules, CSV pipelines.
- Status
- Healthy
- Last Tested
- Transport
- Streamable HTTP
- URL
- Repository
- subhatta123/twilize
- GitHub Stars
- 2
- Server Listing
- twilize
Glama MCP Gateway
Connect through Glama MCP Gateway for full control over tool access and complete visibility into every call.
Full call logging
Every tool call is logged with complete inputs and outputs, so you can debug issues and audit what your agents are doing.
Tool access control
Enable or disable individual tools per connector, so you decide what your agents can and cannot do.
Managed credentials
Glama handles OAuth flows, token storage, and automatic rotation, so credentials never expire on your clients.
Usage analytics
See which tools your agents call, how often, and when, so you can understand usage patterns and catch anomalies.
Tool Definition Quality
Average 3.3/5 across 58 of 58 tools scored. Lowest: 1.9/5.
Most tools have distinct purposes with detailed descriptions, but there is slight potential for confusion among similar verbs like 'add_', 'configure_', and 'apply_' for different targets. However, the descriptions are thorough enough for an agent to differentiate.
Naming follows a mostly consistent verb_noun pattern, with common prefixes like 'add_', 'configure_', 'list_', and 'set_'. Some deviations exist (e.g., 'generate_layout_json', 'export_rules'), but overall the pattern is predictable.
58 tools is high but justified by the broad scope of Tableau dashboard creation from multiple data sources. The count is borderline heavy; some consolidation might be possible, but the coverage is reasonable.
The tool set covers the main lifecycle (inspect, create, configure, style, migrate), but lacks delete/remove operations for worksheets and dashboards. There are also no export tools for images or PDFs, leaving some gaps.
Available Tools
58 toolsadd_calculated_fieldCInspect
Add a calculated field to the datasource.
| Name | Required | Description | Default |
|---|---|---|---|
| role | No | ||
| formula | Yes | ||
| datatype | No | real | |
| field_name | Yes | ||
| field_type | No | ||
| default_format | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, and the description does not disclose side effects, permissions, or return value. For a tool that modifies a datasource, behavioral disclosure is minimal.
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 very concise (6 words) but lacks necessary details. It front-loads the action but is too brief to be fully useful.
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 6 parameters (some with defaults) and no parameter descriptions, the description is incomplete. It does not explain formula syntax or field constraints, nor does it leverage the output schema 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 0% and the description adds no meaning beyond parameter names. Parameters like 'formula' and 'field_name' are essential but unexplained.
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 'Add a calculated field to the datasource' clearly states the action and resource, and distinguishes from siblings like remove_calculated_field and validate_calc_fields. However, it does not specify the context (e.g., Tableau) which is inferred from sibling tools.
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, no prerequisites or conditions mentioned. The description provides no usage context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
add_dashboardCInspect
Create a dashboard combining multiple worksheets.
| Name | Required | Description | Default |
|---|---|---|---|
| width | No | ||
| height | No | ||
| layout | No | vertical | |
| dashboard_name | Yes | ||
| worksheet_names | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so the description must disclose behavioral traits. It only states a creation operation without mentioning side effects, permissions, or whether existing dashboards are affected. Insufficient for an agent to understand implications.
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?
A single, brief sentence that is front-loaded and efficient. No wasted words, though it could be slightly expanded for clarity without losing 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 the presence of an output schema and five parameters, the description covers the core purpose but omits details like return value structure and parameter interactions. Adequate for basic understanding but not fully informative.
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 0%, and the description adds no parameter explanations. While dashboard_name and worksheet_names are self-explanatory, width, height, and layout lack any additional meaning beyond defaults. The description should compensate but does not.
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 action (create) and resource (dashboard) with a key detail (combining multiple worksheets). It distinguishes from siblings like add_dashboard_action and apply_dashboard_theme, though could be more specific about what 'combining' entails.
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 (e.g., csv_to_dashboard or hyper_to_dashboard). No mention of prerequisites or when not to use it. The description provides no context for decision-making.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
add_dashboard_actionCInspect
Add an interaction action to a dashboard.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | Yes | ||
| caption | No | ||
| event_type | No | on-select | |
| action_type | Yes | ||
| source_sheet | Yes | ||
| target_sheet | Yes | ||
| dashboard_name | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, and the description does not disclose behavioral traits such as side effects, permissions, or what 'interaction action' entails. The agent gets minimal behavioral insight.
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 a single sentence, which is concise, but it lacks structure such as bullet points or examples. It could be considered under-specified rather than concise.
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 7 parameters with 0% schema description, no annotations, and an output schema that is not described, the description is far from complete. It does not help the agent understand what constitutes a valid action or how parameters interact.
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 0%, and the description adds no explanation of parameters. Parameter names like 'action_type', 'source_sheet' are somewhat self-explanatory but the description does not clarify their valid values or relationships.
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 adds an interaction action to a dashboard, which distinguishes it from adding a dashboard itself or adding worksheets. However, the term 'interaction action' is not elaborated.
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 other add tools, no prerequisites or exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
add_parameterCInspect
Add a parameter to the workbook.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | ||
| datatype | No | real | |
| max_value | No | ||
| min_value | No | ||
| domain_type | No | range | |
| granularity | No | ||
| default_value | No | 0 | |
| allowed_values | No | ||
| default_format | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description states 'Add', indicating mutation, but no annotations are provided to further clarify behavioral traits. It does not disclose side effects, persistence requirements, or error conditions. The tool likely modifies the workbook schema, but the description offers no details beyond the verb.
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 extremely concise at one sentence, but this brevity sacrifices necessary detail for a tool with nine parameters. It is not well-structured; front-loading the purpose is fine, but parameter guidance is absent.
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 complexity (nine parameters, one required, output schema provided but not described), the description is insufficient. It fails to explain parameter relationships, default behaviors, or the context in which the parameter is added. An output schema exists but is not referenced.
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?
With 0% schema description coverage, the description should compensate by explaining key parameters. Instead, it provides no parameter information. The schema includes nine parameters with defaults but no semantic meaning, leaving the agent to guess their purpose.
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 'Add a parameter to the workbook' uses a specific verb and resource, making the purpose clear. It distinguishes from sibling tools like add_calculated_field or add_dashboard by specifying 'parameter'. However, it does not explicitly differentiate from other 'add' tools.
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, nor any exclusions or prerequisites. The description implies use when needing to add a parameter, but fails to explain how it differs from other add tools or when it is inappropriate.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
add_reference_bandCInspect
Add a reference band (shaded region) to a worksheet.
| Name | Required | Description | Default |
|---|---|---|---|
| scope | No | per-pane | |
| to_value | No | ||
| axis_field | Yes | ||
| fill_color | No | #E0E0E0 | |
| from_value | No | ||
| to_formula | No | constant | |
| from_formula | No | constant | |
| worksheet_name | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden. It fails to disclose any behavioral traits such as whether the operation is destructive, reversible, or requires specific permissions. The brief statement only describes the action, not its implications.
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 a single short sentence, which is too terse for a tool with 8 parameters and no other documentation. It is under-specified, failing to earn its place by providing critical 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 tool's complexity (8 parameters, no schema descriptions, no annotations), the description is extremely incomplete. It does not inform the agent about prerequisites, return values, or how to effectively use the tool, even though an output schema exists.
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 0%, meaning the input schema provides no explanations for any of the 8 parameters. The description does not mention or clarify any parameter meanings (e.g., from_value, scope, axis_field), leaving the agent with no guidance on how to fill them 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 it adds a reference band (shaded region) to a worksheet, which is a specific verb and resource. It effectively distinguishes from sibling tools like add_reference_line and add_trend_line, which add different visual elements.
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 add_reference_line. The description offers no context, exclusions, or comparison, leaving the agent to infer usage from the name alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
add_reference_lineCInspect
Add a reference line to a worksheet (constant, average, median, etc.).
| Name | Required | Description | Default |
|---|---|---|---|
| label | No | ||
| scope | No | per-pane | |
| value | No | ||
| formula | No | constant | |
| axis_field | Yes | ||
| label_type | No | automatic | |
| line_color | No | ||
| worksheet_name | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description only hints at reference line types but fails to disclose important behaviors like whether lines overlay multiple panes, how conflicts with existing lines are handled, or any side effects. This is insufficient for an agent to understand the tool's impact.
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 a single sentence without unnecessary words, making it concise and easy to parse. However, it could benefit from a brief structure listing key options or usage notes.
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 8 parameters, zero schema coverage, and a sibling list of 50+ tools, the description is far too sparse. It does not address tool complexity, required vs optional parameters, output details (though output schema exists), or common pitfalls, leaving the agent underinformed.
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 0%, and the description only loosely explains the 'formula' parameter by listing possible values (constant, average, median). The remaining 7 parameters receive no explanation, leaving the agent reliant on parameter names 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 the action 'Add a reference line to a worksheet' and lists example types (constant, average, median). It distinguishes from sibling tools like add_reference_band by focusing on lines rather than bands, though not explicitly contrasting.
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 vs alternatives such as add_reference_band or add_trend_line. There is no mention of prerequisites or context for appropriate usage.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
add_trend_lineCInspect
Add a trend line to a worksheet (linear, polynomial, log, exp, power).
| Name | Required | Description | Default |
|---|---|---|---|
| fit | No | linear | |
| degree | No | ||
| exclude_color | No | ||
| worksheet_name | Yes | ||
| show_confidence_bands | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description only states the basic action and does not disclose behavioral traits such as whether the trend line replaces or supplements existing ones, error handling for missing worksheets, or any permission requirements. This is insufficient for an agent to understand the tool's 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?
The description is a single sentence, making it concise, but it could benefit from slightly more detail without becoming verbose. However it avoids unnecessary 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 tool has 5 parameters (one required) and no annotation support, the description should provide more context about parameter defaults and relationships. The existence of an output schema does not relieve the need for usage 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?
With schema description coverage at 0%, the description adds little extra meaning beyond the parameter names. It mentions the types of trend lines but does not explain parameters like 'degree', 'exclude_color', or 'show_confidence_bands', which are critical for correct 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 identifies the action (add), the resource (trend line), and lists the types of trend lines supported (linear, polynomial, log, exp, power). This distinguishes it from sibling tools like add_reference_band or add_reference_line.
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, nor any prerequisites or conditions. The description lacks information about when not to use it, leaving the agent without context for appropriate invocation.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
add_worksheetBInspect
Add a new blank worksheet to the workbook.
| Name | Required | Description | Default |
|---|---|---|---|
| worksheet_name | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided; description is minimal and does not disclose potential side effects (e.g., what happens if worksheet name already exists, or if workbook is not open). Adequate for a simple creation tool but lacks depth.
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, succinct sentence with no unnecessary words. Front-loaded with verb and resource.
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 an output schema, the description is somewhat incomplete: it does not specify the target workbook, whether the worksheet is appended, or any constraints. Lacks context given no annotations.
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 one parameter 'worksheet_name' with 0% coverage and no description. The description does not explain the parameter's purpose or constraints, adding no value 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 action ('Add') and the resource ('new blank worksheet') with specific verb-resource pairing, distinguishing it from siblings like 'add_dashboard' or 'add_parameter'.
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 (e.g., when to add a worksheet vs. a dashboard), no prerequisites or context provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
analyze_twbCInspect
Analyze a TWB file against twilize's declared capabilities.
| Name | Required | Description | Default |
|---|---|---|---|
| file_path | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description must fully disclose behavior. It states 'analyze' but does not clarify whether this is a read-only operation, what side effects might occur, or any required permissions. The term 'analyze' is vague and could imply mutation.
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 a single, concise sentence, but it sacrifices necessary details for brevity. It is not overly long, but the lack of structure (e.g., bullet points or separate sections) reduces readability and usefulness.
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 an output schema exists but is not described, and the tool has many siblings with similar names, the description fails to provide complete context. It does not explain what analysis is performed, what the output contains, or how it relates to other tools like 'describe_capability' or 'list_capabilities'.
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 0%, and the single parameter 'file_path' is only explained by its name and type. The description adds no additional context about expected format, accessibility, or constraints beyond the schema's basic type definition.
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 identifies the verb 'analyze', the resource 'TWB file', and the context 'against twilize's declared capabilities'. However, it does not differentiate from sibling tools like 'validate_workbook' or 'profile_twb_for_migration', which have overlapping purposes.
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. There is no mention of prerequisites, when not to use it, or which sibling tools might be more appropriate for specific scenarios.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
apply_color_paletteCInspect
Set a custom color palette. Built-in: tableau10, tableau20, blue-red, green-gold.
| Name | Required | Description | Default |
|---|---|---|---|
| colors | No | ||
| custom_name | No | twilize-palette | |
| palette_name | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are present, so the description bears full responsibility for behavioral disclosure. It mentions built-in palettes but fails to state whether the tool overrides existing palettes, its destructiveness, or authorization requirements.
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 very concise with only two sentences. However, it omits critical information, making it more under-specified than efficiently designed. It earns a middle score for being brief but not sufficiently informative.
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?
With three parameters and an output schema, the description should clarify the tool's effect and parameter usage. It fails to explain what the palette is applied to (workbook? dashboard?) and does not leverage the output schema. In context of many sibling apply tools, it lacks enough detail to distinguish 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 description coverage is 0%, yet the description does not explain the three parameters (colors, custom_name, palette_name). The mention of built-in palettes hints at possible palette_name values, but this is insufficient for a tool with no parameter documentation.
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 states 'Set a custom color palette' which is a specific verb+resource. It mentions built-in palettes (tableau10, etc.), adding clarity. However, it does not distinguish from sibling tools like apply_dashboard_theme or apply_style_reference, which may also alter color settings.
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, nor any prerequisites or restrictions. The description is purely declarative with no usage context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
apply_dashboard_themeCInspect
Apply uniform styling (background, font) to all zones in a dashboard.
| Name | Required | Description | Default |
|---|---|---|---|
| font_family | No | ||
| dashboard_name | Yes | ||
| title_font_size | No | ||
| background_color | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must fully disclose behavior. It mentions 'all zones' but does not specify whether existing styles are overwritten, what happens with empty parameters, or any destructive/read-only aspects.
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 a single sentence with no extraneous text. It is front-loaded with the 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?
Despite having an output schema, the description does not mention return values. For a tool with 4 parameters and no param descriptions, the description is too minimal to be 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?
With 0% schema description coverage, the description should clarify parameter meanings. It only mentions 'background, font' but does not map to actual parameters (font_family, background_color, title_font_size). The required parameter dashboard_name is not explained.
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 action (apply uniform styling) and the target (all zones in a dashboard). It distinguishes from sibling tools like apply_color_palette and apply_style_reference.
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, no prerequisites, and no context about when it's appropriate.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
apply_style_referenceAInspect
Re-skin existing dashboards from a reference image and/or CSS/HTML.
Extracts a colour palette + typography + border styling, then rewrites dashboard and zone backgrounds, borders, and worksheet mark text colours to match.
At least one of image_path, css, or html is required.
apply_to limits the effect to named dashboards; default is all.
Returns the extracted StyleReference dict.
| Name | Required | Description | Default |
|---|---|---|---|
| css | No | ||
| html | No | ||
| apply_to | No | ||
| image_path | No |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description carries full burden. States it rewrites styles but does not disclose if changes are destructive, reversible, or require permissions. Lacks crucial mutation context.
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?
Five concise sentences with front-loaded purpose. No fluff; every sentence provides value. Well-structured with bullet points.
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?
Explains purpose, basic parameters, and return type. Lacks details on behavioral implications (e.g., reversibility, conflict resolution) and error conditions. Adequate but not comprehensive for a mutation 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?
Adds meaning beyond schema titles: clarifies that at least one of image_path, css, or html is required, and apply_to scopes effect. Schema has 0% description coverage, so description compensates well.
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 re-skins dashboards from reference image/CSS/HTML, extracting palette and applying to backgrounds, borders, text. Distinguishes from siblings like apply_color_palette which only apply a palette.
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?
Specifies at least one of image_path, css, or html is required, and apply_to limits effect to named dashboards. Does not explicitly state when not to use or compare to alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
apply_twb_migrationCInspect
Apply a workbook migration and write a migrated TWB plus reports.
| Name | Required | Description | Default |
|---|---|---|---|
| scope | No | workbook | |
| file_path | Yes | ||
| output_path | Yes | ||
| target_source | Yes | ||
| mapping_overrides | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description must convey behavioral traits. It mentions 'apply' and 'write,' implying file modification/creation, but omits details on side effects, reversibility, or required permissions.
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 single-sentence description is brief but under-specified. While concise, it fails to include essential details, making it insufficient for effective agent guidance.
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 (5 parameters, output schema, many siblings), the description is extremely incomplete. It lacks information on migration process, prerequisites, return values, and parameter roles.
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 0%, and the description adds no information about parameters. The agent receives no hints about what 'file_path', 'target_source', or 'mapping_overrides' mean, forcing reliance on parameter names 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 states the action 'apply a workbook migration' and the output 'write a migrated TWB plus reports,' but it does not differentiate from sibling tools like 'preview_twb_migration' or 'migrate_twb_guided,' leaving ambiguity about its specific role.
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, nor are there any contextual hints about prerequisites or typical scenarios.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
configure_chartDInspect
Configure chart type and field mappings for a worksheet.
| Name | Required | Description | Default |
|---|---|---|---|
| rows | No | ||
| size | No | ||
| color | No | ||
| label | No | ||
| detail | No | ||
| columns | No | ||
| filters | No | ||
| tooltip | No | ||
| color_map | No | ||
| mark_type | No | Automatic | |
| label_runs | No | ||
| map_fields | No | ||
| map_layers | No | ||
| wedge_size | No | ||
| label_param | No | ||
| text_format | No | ||
| measure_values | No | ||
| worksheet_name | Yes | ||
| mark_sizing_off | No | ||
| sort_descending | No | ||
| axis_fixed_range | No | ||
| customized_label | No | ||
| geographic_field | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, and the description does not disclose any behavioral traits beyond the vague verb 'configure'. It does not state whether the operation is destructive, what the impact is on existing chart settings, or any authorization 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 only one sentence, which is insufficient given the tool's complexity (23 parameters). It is under-specified rather than concise, lacking necessary 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?
Despite having an output schema, the description is completely inadequate for a tool with 23 parameters and no annotations. It fails to provide any context about parameter relationships, default behaviors, or expected outcomes.
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?
With 0% schema description coverage and no explanation of any of the 23 parameters, the description adds no meaning beyond the parameter names. The agent has no context for how to use parameters like 'rows', 'color', or 'mark_type'.
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 configures chart type and field mappings for a worksheet, which is a specific verb+resource. However, it does not differentiate from the sibling tool 'configure_chart_recipe', which might overlap.
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 'configure_chart_recipe' or 'configure_worksheet_style'. No prerequisites 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.
configure_chart_recipeCInspect
Configure a showcase recipe chart through the shared recipe registry.
| Name | Required | Description | Default |
|---|---|---|---|
| recipe_args | No | ||
| recipe_name | Yes | ||
| worksheet_name | Yes | ||
| auto_ensure_prerequisites | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, description carries full burden. It only says 'Configure' without clarifying whether it creates, updates, or deletes, nor any permissions or side effects. Extremely minimal.
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 sentence, no waste, but lacks necessary detail. Conciseness is okay but at the expense of completeness.
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 having output schema, description does not set expectations on return values. For a tool with 4 params and no param descriptions, extremely incomplete.
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 0%, and description does not explain any parameter meaning. The description fails to add value beyond the schema structure.
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 verb 'configure', specific resource 'showcase recipe chart', and mechanism 'through the shared recipe registry'. This distinguishes it from sibling like 'configure_chart' which likely handles direct chart config.
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 explicit guidance on when to use this tool vs alternatives like 'configure_chart'. Implies a registry-based approach, but lacks exclusions or context for selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
configure_dual_axisCInspect
Configure a dual-axis chart composition.
| Name | Required | Description | Default |
|---|---|---|---|
| rows | No | ||
| size_1 | No | ||
| size_2 | No | ||
| color_1 | No | ||
| color_2 | No | ||
| columns | No | ||
| filters | No | ||
| label_1 | No | ||
| label_2 | No | ||
| detail_1 | No | ||
| detail_2 | No | ||
| hide_axes | No | ||
| color_map_1 | No | ||
| mark_type_1 | No | Bar | |
| mark_type_2 | No | Line | |
| show_labels | No | ||
| mark_color_1 | No | ||
| mark_color_2 | No | ||
| size_value_1 | No | ||
| size_value_2 | No | ||
| synchronized | No | ||
| wedge_size_1 | No | ||
| wedge_size_2 | No | ||
| hide_zeroline | No | ||
| reverse_axis_1 | No | ||
| worksheet_name | Yes | ||
| dual_axis_shelf | No | rows | |
| mark_sizing_off | No | ||
| sort_descending | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description must disclose behavioral traits. It only states 'configure' without explaining effects (e.g., modifies existing worksheet, requires worksheet_name, impact on chart state).
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 sentence is concise but lacks necessary detail. Not wasteful, but also not earning its place with meaningful 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 29 parameters and no annotations, the description is woefully incomplete. No mention of output schema, return values, or behavior. Far from minimum viable.
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 0%, and description adds no parameter meaning. With 29 parameters, the description should clarify their roles but fails entirely.
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 configures a dual-axis chart composition. However, it does not differentiate from sibling tools like 'configure_chart' and 'configure_chart_recipe', which could have overlapping purposes.
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 configure_chart. No prerequisites, conditions, or exclusions mentioned.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
configure_worksheet_styleCInspect
Apply worksheet-level styling: background color, axis/grid/border visibility.
| Name | Required | Description | Default |
|---|---|---|---|
| hide_axes | No | ||
| axis_style | No | ||
| cell_formats | No | ||
| hide_borders | No | ||
| hide_reflines | No | ||
| hide_zeroline | No | ||
| label_formats | No | ||
| header_formats | No | ||
| hide_droplines | No | ||
| hide_gridlines | No | ||
| worksheet_name | Yes | ||
| disable_tooltip | No | ||
| hide_band_color | No | ||
| pane_cell_style | No | ||
| pane_mark_style | No | ||
| background_color | No | ||
| hide_table_dividers | No | ||
| pane_datalabel_style | No | ||
| hide_col_field_labels | No | ||
| hide_row_field_labels | No | ||
| pane_trendline_hidden | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description bears full responsibility for disclosing behavioral traits. However, it does not mention side effects, destructiveness, or whether existing styles are overwritten. It lacks details about required permissions or state changes, leaving agents to assume it is a simple, non-destructive update.
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 a single, front-loaded sentence that immediately conveys the tool's action and scope. It is concise and avoids unnecessary words, though it could be slightly expanded to cover the range of parameters more explicitly without becoming verbose.
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 (21 parameters, no schema descriptions, no annotations), the description is too brief. It does not prepare agents for the variety of styling options available, nor does it reference the output schema. An agent lacking domain knowledge would struggle to use this tool effectively without additional documentation.
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 21 parameters with zero schema descriptions. The description only covers a subset (background color, visibility of axes, gridlines, borders) and does not explain the many other parameters like hide_zeroline, cell_formats, or label_formats. This leaves agents in the dark about how to configure the remaining options.
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: 'Apply worksheet-level styling' and lists the types of styling (background color, axis/grid/border visibility). It distinguishes from sibling tools like configure_chart (chart-level) and apply_color_palette, making it easy for an agent to select the correct tool for worksheet-level style changes.
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 no guidance on when to use this tool versus alternatives, such as configure_chart or apply_style_reference. It does not mention prerequisites, when not to use it, or any trade-offs. Agents would have to infer usage from the tool name and description alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
create_workbookBInspect
Create a new workbook from a TWB or TWBX template file.
| Name | Required | Description | Default |
|---|---|---|---|
| template_path | No | ||
| workbook_name | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden of disclosing behavior. It only states the input is a template, but does not specify what happens if the template is invalid, whether existing workbooks are overwritten, or any other behavioral traits. The existence of an output schema mitigates return value details, but behavioral aspects are still lacking.
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 a single sentence and avoids verbosity. However, it sacrifices informativeness for brevity, missing important details that could be added without becoming 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?
Given that there are two parameters and no annotations, the description is too brief to be complete. It does not address prerequisites, constraints, or additional context needed for correct invocation. The presence of an output schema partially compensates, but the description remains insufficient.
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?
With 0% schema description coverage, the description must explain the parameters. It mentions 'template file' but does not clarify the 'template_path' parameter (e.g., format, requiredness) or the 'workbook_name' parameter (e.g., default behavior if empty). The description adds minimal value 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 action (create), the resource (workbook), and the specific source (TWB or TWBX template file). This distinguishes it from sibling tools like 'open_workbook' or 'save_workbook'.
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 that the tool is for creating workbooks from templates, but it does not explicitly state when to use this tool over alternatives (e.g., creating from scratch). No exclusions or context are provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
csv_to_dashboardAInspect
Build a complete Tableau dashboard from a CSV file (end-to-end).
Pipeline: CSV → schema inference → chart suggestion → Hyper extract → workbook creation → chart configuration → dashboard layout → .twbx output.
IMPORTANT FOR AI AGENTS — know before you call:
Auto-selected charts are picked by RULES (data shape + heuristics), NOT by natural-language chart requests. To guarantee a specific chart (e.g. "top 10 customers by profit") you MUST pass it via
required_charts; otherwise it may or may not be generated and may be trimmed out bymax_charts.The user's reference image is NOT automatically read from the chat. If the user asks for styling "like this image", you must save the image to disk and pass its path via
reference_image.This tool returns a STRUCTURED MANIFEST dict describing what was actually built. Always cite fields from the returned manifest (worksheets / theme / dashboards) when describing the result to the user — do NOT invent charts that are not listed there.
Args: csv_path: Path to the source CSV file. output_path: Output .twbx path (defaults to <csv_stem>_dashboard.twbx). dashboard_title: Dashboard title (derived from filename if empty). max_charts: Maximum number of charts (0 = use dashboard_rules.yaml default). template_path: TWB template path (empty for default template). theme: Theme preset name (empty = use dashboard_rules.yaml default). Options: modern-light, modern-dark, classic, minimal, vibrant. rules_yaml: Optional YAML string with dashboard rules overrides. Example: "kpi:\n font_size: 32\n max_kpis: 3" required_charts: Optional list of chart specs that MUST be built. Each entry is a dict, for example::
{"title": "Top 10 Customers by Profit",
"kind": "bar",
"rows": "Customer Name",
"columns": "SUM(Profit)",
"top_n": 10, "top_by": "SUM(Profit)",
"sort_descending": "SUM(Profit)"}
Supported kinds: bar, line, scatter, pie, map, heatmap,
tree_map, text. Required charts bypass dedup + trim.
reference_image: Optional path to a PNG/JPG whose palette should
drive the dashboard styling. Applied AFTER the theme so image
colours win. The path must exist on disk; chat attachments
need to be saved first.Returns:
Structured manifest dict with keys: status, output_path,
source, dashboards, worksheets, charts_built,
required_charts_fulfilled, dropped_suggestions, theme,
warnings, summary. Cite THIS dict when describing results.
| Name | Required | Description | Default |
|---|---|---|---|
| theme | No | ||
| csv_path | Yes | ||
| max_charts | No | ||
| rules_yaml | No | ||
| output_path | No | ||
| template_path | No | ||
| dashboard_title | No | ||
| reference_image | No | ||
| required_charts | No |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description fully discloses behavioral traits: auto-selection via rules, bypassing with required_charts, need to save reference images, and return of a structured manifest. It also mentions that charts may be trimmed by max_charts.
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 a clear purpose, pipeline overview, important notes, and parameter list. Every sentence adds value and is logically ordered, making it easy to parse despite length.
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 the tool's purpose, pipeline, behavioral nuances, all parameters, and return value (including manifest structure). It is fully self-contained and addresses potential agent questions, ensuring complete 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 coverage is 0%, but the description adds detailed explanations for all 9 parameters in the 'Args:' section, including examples for required_charts and reference_image, and options for theme. This completely compensates for the schema's lack of 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 'Build a complete Tableau dashboard from a CSV file (end-to-end).' and lists the pipeline steps. It distinguishes from sibling tools by emphasizing CSV input, which is unique among similar tools like hyper_to_dashboard or mssql_to_dashboard.
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 'IMPORTANT FOR AI AGENTS' section provides explicit guidance on when to use required_charts and how to handle reference images. However, it does not explicitly contrast with sibling tools or state when not to use this tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
csv_to_hyperAInspect
Convert a CSV file to a Tableau Hyper extract.
Infers column types and creates a .hyper file that can be used as a data source in Tableau workbooks.
Requires tableauhyperapi (pip install tableauhyperapi).
Args: csv_path: Path to the source CSV file. hyper_path: Output path for the .hyper file. table_name: Table name inside the Hyper file. sample_rows: Rows to sample for type inference.
Returns: Confirmation with row and column counts.
| Name | Required | Description | Default |
|---|---|---|---|
| csv_path | Yes | ||
| hyper_path | Yes | ||
| table_name | No | Extract | |
| sample_rows | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description must detail behavioral traits. It states that column types are inferred using sample rows and that a file is created, but omits important details like overwrite behavior, error handling, or performance implications. This is adequate but has gaps.
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 only 8 lines covering purpose, functionality, requirements, arguments, and return value. It is front-loaded with the core action and structured as a docstring, making it easy to scan.
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 moderate complexity (4 parameters, no output schema in the description but context says one exists), the description provides a complete overview: what it does, parameters, return value, and a dependency. It lacks usage context or prerequisites beyond the pip install, which is acceptable.
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 0% description coverage, so the description's parameter documentation is essential. It explains each parameter (csv_path, hyper_path, table_name, sample_rows) with clear, concise descriptions, adding value beyond the schema's bare titles. However, it could be more specific about path formats or constraints.
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 action ('Convert a CSV file to a Tableau Hyper extract') and the result ('creates a .hyper file'). It also mentions type inference, which distinguishes it from simple file conversion tools. Among siblings, this tool is unique for CSV-to-Hyper conversion, so purpose is 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 implies usage when a Hyper extract is needed, and provides a prerequisite (require tableauhyperapi). However, it does not mention when alternative tools (e.g., csv_to_dashboard, inspect_csv) would be more appropriate, nor does it state when not to use this tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
describe_capabilityCInspect
Describe one declared capability and its support tier.
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | ||
| name | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, and description only states purpose; lacks any behavioral traits such as read-only nature, authentication needs, or 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?
Single sentence is concise but overly terse, missing essential details that could fit within a slightly longer description.
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 having an output schema, tool lacks explanation of input parameters, making it incomplete for correct invocation without external knowledge.
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 0% and description provides no additional meaning for parameters 'kind' and 'name'; both remain ambiguous.
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 uses specific verb 'describe' and resource 'one declared capability and its support tier,' clearly distinguishing from sibling like list_capabilities which lists all capabilities.
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 vs alternatives; does not mention when this tool is preferred over list_capabilities or other tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
diff_template_gapCInspect
Summarize the non-core capability gap of a TWB template.
| Name | Required | Description | Default |
|---|---|---|---|
| file_path | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must bear the full burden of behavioral disclosure. The single sentence does not indicate side effects (e.g., read-only vs. mutation), nor does it explain what 'summarize' entails in terms of permissions, data persistence, or response 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 very brief (8 words), which is concise but at the expense of informativeness. It lacks structure and does not front-load critical information beyond a minimal purpose statement.
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 having an output schema (indicated), the description does not explain what the output contains or clarify the concept of 'non-core capability gap'. The tool's complexity is low (one param), but the description is too sparse to be complete, especially given zero schema description coverage.
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 one parameter 'file_path' with 0% description coverage. The description adds no additional meaning about this parameter, such as expected format, path scope, or constraints. Since schema coverage is zero, the description should compensate but fails to do so.
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 uses the specific verb 'Summarize' and identifies the resource as 'non-core capability gap of a TWB template'. It clearly distinguishes the tool's purpose from siblings, though the term 'non-core capability gap' is somewhat jargon-heavy.
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. With many sibling tools like 'analyze_twb', 'preview_twb_migration', and 'migrate_twb_guided', the lack of usage context makes it difficult for an agent to decide which tool to invoke.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
export_rulesAInspect
Export the current active rules to a YAML file.
Saves the complete rules (including any runtime changes from set_rule()) to a YAML file that can be placed next to data files or in the working directory for future sessions.
Args: output_path: Path to save the YAML file. Defaults to ./dashboard_rules.yaml in the current working directory.
Returns: Path to the saved file and summary.
| Name | Required | Description | Default |
|---|---|---|---|
| output_path | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description bears full responsibility for behavioral disclosure. It describes the tool as exporting rules to a file, implying a read-only operation on the rules themselves. It does not mention side effects like file overwriting, but overall, the behavior is clear and non-destructive, which 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 compact and well-structured with a clear statement of purpose in the first sentence, followed by a short explanation of context, and an args/returns section. Every part contributes meaning; no redundant 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?
For a simple export tool with one parameter and an output schema (existence known but not shown), the description covers the key aspects: purpose, argument, and return. It could be slightly enhanced by noting that the tool does not modify server state, but it is largely 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 input schema has 0% description coverage, so the description must compensate. It fully explains the only parameter, output_path, including its purpose, default value, and example file path. This adds significant value beyond the schema's property definition.
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 exports current active rules to a YAML file. It specifies 'Export' as the verb and 'active rules' as the resource, making intent obvious. It hints at differentiation from sibling tools like get_active_rules by mentioning inclusion of runtime changes from set_rule(), but does not explicitly contrast with similar tools, so it's not a full 5.
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 context for when to use the tool: to persist current rules including runtime changes for future sessions. However, it doesn't specify when not to use it or mention alternatives like get_active_rules for non-export needs, leaving the agent without explicit guidance on tool selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
generate_layout_jsonCInspect
Generate and save a dashboard layout JSON file.
| Name | Required | Description | Default |
|---|---|---|---|
| layout_tree | Yes | ||
| output_path | Yes | ||
| ascii_preview | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries full burden but only says 'generate and save', omitting details like file destination, overwrite behavior, permissions, or return value. The output schema exists but is not described.
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?
While a single sentence is concise, it is under-specified for a tool with three parameters, including a complex object with additionalProperties. Conciseness does not compensate for missing crucial 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?
The description lacks detail on the layout_tree structure, ascii_preview purpose, output behavior, and return value, making it incomplete given the tool's complexity and sibling landscape.
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 0%, and the description adds no value beyond parameter names; it does not explain the layout_tree structure, output_path format, or ascii_preview role.
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 generates and saves a dashboard layout JSON file, which differentiates it from siblings like add_dashboard that add dashboards rather than generating layout files.
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 add_dashboard or other layout-related tools, nor does it mention prerequisites or contexts.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_active_rulesAInspect
Return the active dashboard creation rules.
Call this at the start of a session to understand what constraints are enforced. The rules engine validates every configure_chart and add_dashboard call — violations are returned as errors or warnings.
Returns: Human-readable summary of all active rules.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description bears the burden. It mentions the return type (human-readable summary) and that it checks constraints for configure_chart and add_dashboard, but does not disclose if it has side effects or cost.
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 three sentences, minimal and front-loaded with the purpose. Every sentence adds value without being verbose.
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 parameters and an output schema (though not shown), the description explains the return value and how this tool relates to other tools. It is complete 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 zero parameters, so schema coverage is 100%. The description adds no parameter info, but baseline for 0 params is 4. No contradiction with 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 returns the active dashboard creation rules, using a specific verb and resource. It also explains its usage context, distinguishing it from siblings like set_rule and reset_rules.
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 to call this at the start of a session to understand constraints, providing clear usage context. It does not specify when not to use it or alternatives, but the guidance is sufficient.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
hyper_to_dashboardAInspect
Build a complete Tableau dashboard from a Hyper extract file (end-to-end).
Pipeline: Hyper → schema inference → chart suggestion → workbook creation → chart configuration → dashboard layout → .twbx output.
IMPORTANT FOR AI AGENTS: auto-charts come from rules, not from
natural-language requests. Use required_charts to guarantee a
specific chart and reference_image for image-based styling. The
returned manifest dict is the SOURCE OF TRUTH — don't invent charts
that aren't in it.
Args:
hyper_path: Path to the .hyper file.
output_path: Output .twbx path (defaults to <hyper_stem>_dashboard.twbx).
dashboard_title: Dashboard title (derived from filename if empty).
max_charts: Maximum number of charts (0 = use rules default).
template_path: TWB template path (empty for default template).
table_name: Table name inside the Hyper file (empty = first table).
theme: Theme preset name (empty = use rules default).
rules_yaml: Optional YAML string with dashboard rules overrides.
required_charts: See csv_to_dashboard.required_charts.
reference_image: See csv_to_dashboard.reference_image.
Returns: Structured manifest dict describing what was actually built.
| Name | Required | Description | Default |
|---|---|---|---|
| theme | No | ||
| hyper_path | Yes | ||
| max_charts | No | ||
| rules_yaml | No | ||
| table_name | No | ||
| output_path | No | ||
| template_path | No | ||
| dashboard_title | No | ||
| reference_image | No | ||
| required_charts | No |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Despite no annotations, the description explains the full pipeline and critical behaviors: auto-charts come from rules, not NL requests, and the manifest is authoritative. It could further disclose non-destructive nature or performance characteristics, but overall provides good 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 a clear purpose sentence, pipeline list, special instructions, and parameter details. It is appropriately sized for the tool complexity, though the Args section is slightly lengthy but necessary due to lack of schema descriptions.
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 high number of parameters, no output schema, and no annotations, the description covers the pipeline, parameter semantics, and behavioral notes adequately. It could mention prerequisites (e.g., Hyper file must exist) but overall provides sufficient context for correct tool invocation.
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?
With 0% schema description coverage, the description compensates fully by providing an Args section that explains every parameter's purpose, defaults, and special notes (e.g., required_charts references csv_to_dashboard). This adds significant value 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 'Build a complete Tableau dashboard from a Hyper extract file (end-to-end)' and lists the pipeline steps. This verb+resource combination is specific and distinguishes from sibling tools like csv_to_dashboard, which handle different input formats.
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 includes an 'IMPORTANT FOR AI AGENTS' section with guidance on using required_charts and reference_image, and notes that the manifest is the source of truth. However, it does not explicitly compare to siblings or state when to use this tool over others (e.g., csv_to_dashboard).
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
inspect_csvAInspect
Inspect a CSV file and return its inferred schema with column classification.
Reads the CSV, infers column types (integer, float, date, boolean, string), classifies columns as dimensions or measures with semantic types (categorical, temporal, geographic, numeric), and returns a summary.
Args: csv_path: Path to the CSV file. sample_rows: Number of rows to sample for type inference. encoding: File encoding (default utf-8).
Returns: Human-readable schema summary with dimensions, measures, and types.
| Name | Required | Description | Default |
|---|---|---|---|
| csv_path | Yes | ||
| encoding | No | utf-8 | |
| sample_rows | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Describes the main behavior but lacks details on side effects, performance, or error handling. No annotations to supplement.
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?
Concise and well-structured: clear summary, then details, then Args. 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?
Covers key aspects of CSV inspection and schema output. An output schema exists, so return value details are less critical.
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?
Description includes an Args section that explains each parameter meaning, compensating for the 0% schema description 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?
Clearly states it inspects a CSV, infers schema, and classifies columns. Distinguishes from siblings like profile_csv and csv_to_dashboard.
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?
Implies usage for schema inspection but no explicit guidance on when not to use or comparison with alternatives like profile_csv.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
inspect_hyperAInspect
Inspect a Hyper extract file and return its schema with column classification.
Reads the Hyper file, maps column types, classifies columns as dimensions or measures, and returns a summary.
Requires tableauhyperapi (pip install tableauhyperapi).
Args: hyper_path: Path to the .hyper file. table_name: Specific table to inspect (empty = first table).
Returns: Human-readable schema summary with dimensions, measures, and types.
| Name | Required | Description | Default |
|---|---|---|---|
| hyper_path | Yes | ||
| table_name | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations exist, so the description carries full burden. It discloses the process: reads file, maps types, classifies columns, and returns a summary. It also notes the requirement of tableauhyperapi. Missing details on error handling or edge cases (e.g., missing table), but for a read-only inspection tool, the transparency 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 structured with a summary sentence, a process line, a prerequisite note, and an Args/Returns section. It is front-loaded with the main purpose. Minor redundancy in the process line could be tightened, but overall it is concise and well-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 tool's moderate complexity, the description covers key aspects: input parameters, prerequisite, and return format (human-readable schema summary). It does not detail the output schema structure or error handling, but the presence of an output schema (not shown) reduces the need for full return value documentation.
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 0%, so the description compensates by explaining both parameters: hyper_path is the path to the .hyper file, and table_name defaults to the first table if empty. This adds meaningful context beyond the schema titles, though further constraints (e.g., valid file extensions) could be added.
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: 'Inspect a Hyper extract file and return its schema with column classification.' It specifies the verb (inspect), resource (.hyper file), and output (schema with dimensions/measures), distinguishing it from siblings like inspect_csv or list_fields.
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 a prerequisite (tableauhyperapi) but does not explicitly state when to use this tool versus alternatives like inspect_csv. Usage context is implied by the tool name and sibling list, but the description lacks direct guidance on 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.
inspect_target_schemaCInspect
Inspect the first-sheet schema of a target Excel datasource.
| Name | Required | Description | Default |
|---|---|---|---|
| target_source | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description must disclose behavioral traits. It only says 'inspect', implying a read operation, but does not confirm if it's fast, requires file access, or any side effects. No information about return format is given, though an output schema exists.
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 a single short sentence, making it concise. However, it lacks structure (e.g., no line breaks or sections) and is too brief to be truly effective. It earns its place but could be expanded.
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 presence of an output schema, return values are partially covered. However, the description omits context about the parameter, prerequisites, and how the tool fits into the workflow. Sibling tools are numerous, so more context would help.
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 a required parameter 'target_source' with no description (0% coverage). The description does not explain what this parameter represents or how to format it (e.g., path, URL). This is a critical gap.
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 inspects the first-sheet schema of an Excel datasource, which distinguishes it from siblings like inspect_csv and inspect_hyper that target other formats. However, it does not explicitly say 'use this for Excel files only', leaving slight 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 description provides no guidance on when to use this tool versus alternatives, such as when inspecting CSV or Hyper files. It also lacks any prerequisites or context for invocation.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_capabilitiesAInspect
List twilize's declared capability boundary.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must fully disclose behavior. It only says 'list' without mentioning that it is read-only, safe, or performance characteristics. The agent lacks insight into side effects or authorization 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 a single, short sentence achieving maximal conciseness. However, it could be slightly more informative (e.g., 'Returns a list of all capabilities') without harming 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?
For a no-parameter tool with an output schema, the description is minimally complete. However, it does not clarify what the output contains (e.g., capability names only or full definitions), leaving potential ambiguity.
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 and 100% schema description coverage. Per guidelines, no parameters yield a baseline of 4. The description adds no parameter detail, but none is needed.
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 action 'List' and the resource 'twilize's declared capability boundary'. It is specific and distinguishes from the sibling 'describe_capability' by implying a summary vs. detailed view.
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 use for discovering available capabilities but provides no explicit guidance on when to use this tool versus siblings like 'describe_capability'. No exclusion criteria or alternatives are given.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_dashboardsAInspect
List dashboards and their worksheet zones in the current workbook.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
As a read-only list operation with no annotations, the description conveys no side effects. It adds context by specifying 'worksheet zones' and 'current workbook,' which is adequate for behavioral understanding.
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 a single, clear sentence with no redundant words. It is front-loaded with the action and resource, earning its place without waste.
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 parameters and the presence of an output schema, the description fully explains the tool's purpose and scope (current workbook, dashboards with worksheet zones), requiring no additional detail.
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?
There are zero parameters, so no parameter documentation is needed. The description does not need to add param-specific information, meeting the baseline of 4.
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 uses specific verb 'list' and clearly identifies resource 'dashboards and their worksheet zones' in the current workbook. It effectively distinguishes from sibling tools like add_dashboard or list_worksheets.
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 clearly states the context (current workbook) but does not explicitly mention when to avoid or alternative tools. However, the simplicity of the tool makes implicit understanding sufficient.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_fieldsAInspect
List all available fields in the current workbook datasource.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations to rely on, the description carries full burden for behavioral transparency. It only states the action and scope but does not disclose whether the operation is read-only, requires an open workbook, or any other behavioral traits.
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 a single, well-formed sentence that front-loads the purpose with no unnecessary words. It is concise 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 no parameters and an output schema exists, the description sufficiently covers the necessary context by specifying the scope ('current workbook datasource'). It leaves no major gaps for a simple list operation.
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?
There are no parameters, so the description does not need to add meaning beyond the schema. Baseline of 4 is appropriate given the zero parameters and 100% schema description 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 verb 'List' and the resource 'all available fields in the current workbook datasource'. It implicitly distinguishes itself from sibling list tools by specifying 'fields', making it obvious when to use this tool.
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 no guidance on when to use this tool versus alternatives like list_dashboards or list_worksheets. It does not mention any prerequisites or context, leaving the agent to infer usage from the name alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_gallery_templatesAInspect
List all templates in the gallery with suitability rules.
Templates are user-editable YAML files in templates/gallery/.
Each template defines layout zones, suitability criteria, recommended
themes, and auto-wired interaction actions.
Returns: Formatted listing of all gallery templates.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description must carry behavioral disclosure. It implies a read-only listing but does not explicitly state non-destructiveness, performance considerations, or side effects. The description adds context about YAML files but lacks transparency on behavior beyond listing.
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?
Three sentences plus a Returns line, front-loaded with purpose, no fluff. Every sentence earns its place.
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 and the presence of an output schema, the description is adequate. It explains what templates are and what the listing returns, though it could mention the read-only nature explicitly.
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?
With 0 parameters, baseline is 4. The description adds meaning by explaining that templates are YAML files with layout zones, suitability criteria, etc., which adds value beyond the empty 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 templates in the gallery with suitability rules' using specific verb-resource pair. It differentiates from sibling list tools (e.g., list_dashboards, list_fields) by focusing on gallery templates and their suitability rules.
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 recommend_template or diff_template_gap. While the purpose is clear, explicit usage context is missing.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_worksheetsAInspect
List worksheet names in the current workbook.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description must disclose behavior. It acknowledges the tool operates on the 'current workbook' but does not clarify if it returns only names or full metadata, or whether it modifies state. For a simple read operation, this is minimally 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?
A single sentence efficiently conveys the purpose with no unnecessary words. It is appropriately front-loaded and concise.
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 output schema exists (not shown but known) and the tool is simple, the description is sufficiently complete. It lacks context about the workbook scope but does not require more for a basic 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?
There are zero parameters, so the baseline is 4. The description adds value by specifying the scope ('current workbook'), which is not explicit 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 clearly states the action (list) and the resource (worksheet names), distinguishing it from sibling tools that add, configure, or validate worksheets.
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 like add_worksheet or configure_worksheet_style. The description does not mention dependencies or prerequisites.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
migrate_twb_guidedCInspect
Run the built-in migration workflow and pause for warning confirmation when needed.
| Name | Required | Description | Default |
|---|---|---|---|
| scope | No | workbook | |
| file_path | Yes | ||
| output_path | No | ||
| target_source | Yes | ||
| mapping_overrides | No | ||
| apply_if_no_blockers | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations exist, so description must carry full burden. It discloses pausing for confirmation, but omits critical traits like whether it modifies files, requires permissions, or how warnings are handled. Insufficient for safe invocation.
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 a single sentence, but it is under-specified for the tool's complexity (6 parameters, many siblings). Conciseness comes at the cost of missing essential 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?
Despite having an output schema, the description does not mention return values or behavior. With 6 parameters and no parameter docs, the description is critically incomplete.
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 0%, and the description provides no explanation of any of the 6 parameters. The agent must guess from names alone, which is inadequate.
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 indicates it runs a built-in migration workflow and pausing for warnings. However, among siblings like 'apply_twb_migration' and 'preview_twb_migration', the uniqueness is not strongly differentiated, missing why 'guided' differs.
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 explicit guidance on when to use this tool versus siblings. The description only implies using it for migration with warnings, but 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.
mssql_to_dashboardAInspect
Build a Tableau dashboard from a Microsoft SQL Server table (end-to-end).
Pipeline: MSSQL → schema inference → chart suggestion → workbook creation → live MSSQL connection → .twb output.
Requires pyodbc for schema inference and ODBC Driver 17 for SQL Server.
IMPORTANT FOR AI AGENTS: see csv_to_dashboard — auto-charts come
from rules, not natural-language requests. Use required_charts to
guarantee specific charts, reference_image for image-based
styling, and cite the returned manifest dict when describing results.
Args:
server_host: MSSQL server hostname.
dbname: Database name.
table_name: Table to visualize.
username: Database username (ignored if trusted_connection=True).
password: Database password (used for schema inference only).
port: Server port (default 1433).
trusted_connection: Use Windows Authentication instead of SQL auth.
output_path: Output .twb path (defaults to _dashboard.twb).
dashboard_title: Dashboard title.
max_charts: Maximum charts (0 = use rules default).
template_path: TWB template path.
theme: Theme preset name.
rules_yaml: Optional YAML string with dashboard rules overrides.
required_charts: See csv_to_dashboard.required_charts.
reference_image: See csv_to_dashboard.reference_image.
Returns: Structured manifest dict describing what was actually built.
| Name | Required | Description | Default |
|---|---|---|---|
| port | No | ||
| theme | No | ||
| dbname | Yes | ||
| password | No | ||
| username | No | ||
| max_charts | No | ||
| rules_yaml | No | ||
| table_name | Yes | ||
| output_path | No | ||
| server_host | Yes | ||
| template_path | No | ||
| dashboard_title | No | ||
| reference_image | No | ||
| required_charts | No | ||
| trusted_connection | No |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Without annotations, the description carries the full burden. It details the pipeline, dependencies, authentication behavior (username ignored if trusted_connection, password used only for schema inference), and that auto-charts are rule-based, not natural language.
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 a clear first sentence, pipeline, requirements, an important note for agents, and a detailed Args list. While the Args list is long, it is necessary for 15 parameters; it could be slightly more concise but remains effective.
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 (end-to-end pipeline, many parameters, dependencies), the description covers prerequisites, output (manifest dict), and usage. It is complete and leaves no major 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?
Despite 0% schema description coverage, the description includes an extensive Args section that explains each parameter's role, defaults, and special behavior (e.g., 'username ignored if trusted_connection=True', 'password used for schema inference only'). This fully compensates for the schema gap.
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 builds a Tableau dashboard from a SQL Server table end-to-end, lists the pipeline steps, and distinguishes it from siblings like csv_to_dashboard and mysql_to_dashboard.
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 when to use the tool, references csv_to_dashboard for understanding auto-chart behavior, and suggests using required_charts and reference_image for specific needs. However, it does not explicitly exclude alternatives like mysql_to_dashboard.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
mysql_to_dashboardAInspect
Build a Tableau dashboard from a MySQL table (end-to-end).
Pipeline: MySQL → schema inference → chart suggestion → workbook creation → live MySQL connection → .twb output.
Requires mysql-connector-python for schema inference.
IMPORTANT FOR AI AGENTS: see csv_to_dashboard — auto-charts come
from rules, not natural-language requests. Use required_charts to
guarantee specific charts, reference_image for image-based
styling, and cite the returned manifest dict when describing results.
Args:
server_host: MySQL server hostname.
dbname: Database name.
table_name: Table to visualize.
username: Database username.
password: Database password (used for schema inference only;
not stored in the workbook).
port: Server port (default 3306).
output_path: Output .twb path (defaults to _dashboard.twb).
dashboard_title: Dashboard title.
max_charts: Maximum charts (0 = use rules default).
template_path: TWB template path.
theme: Theme preset name.
rules_yaml: Optional YAML string with dashboard rules overrides.
required_charts: See csv_to_dashboard.required_charts.
reference_image: See csv_to_dashboard.reference_image.
Returns: Structured manifest dict describing what was actually built.
| Name | Required | Description | Default |
|---|---|---|---|
| port | No | ||
| theme | No | ||
| dbname | Yes | ||
| password | No | ||
| username | Yes | ||
| max_charts | No | ||
| rules_yaml | No | ||
| table_name | Yes | ||
| output_path | No | ||
| server_host | Yes | ||
| template_path | No | ||
| dashboard_title | No | ||
| reference_image | No | ||
| required_charts | No |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries full burden. It reveals the pipeline steps, that the password is used only for schema inference and not stored, that auto-charts come from rules not natural language, and that the tool returns a manifest dict. It does not mention potential side effects like file overwriting.
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: a one-sentence summary, a pipeline outline, an important note, and a parameter list. It is front-loaded and every sentence adds value 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?
Given 14 parameters, no output schema, and no annotations, the description covers the pipeline, prerequisites, and key behaviors. It could include more details on error handling or connection security, but overall it is comprehensive 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?
The input schema has 0% description coverage, but the description includes a detailed Args section that explains each parameter's purpose, defaults, and usage. This adds significant value beyond the bare schema titles.
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 'Build a Tableau dashboard from a MySQL table (end-to-end)' which provides a specific verb and resource, and it clearly distinguishes this tool from its siblings (e.g., csv_to_dashboard, hyper_to_dashboard) by specifying the MySQL source.
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 states the prerequisite (mysql-connector-python) and directs the agent to csv_to_dashboard for understanding auto-charts behavior. It implies when to use this tool (for MySQL sources) but does not explicitly list alternatives or 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.
open_workbookCInspect
Open an existing workbook (.twb or .twbx) for in-place worksheet editing.
| Name | Required | Description | Default |
|---|---|---|---|
| file_path | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description should disclose behavioral traits. It only states 'open for in-place worksheet editing' but does not reveal if the workbook is modified, if data is loaded, or if existing content is replaced. Critical safety information is missing.
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 a single concise sentence that front-loads the main action. It is efficient with no unnecessary 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 simplicity of the tool (one required parameter, output schema exists), the description is minimally adequate. However, it lacks details about error conditions, permissions, or behavior for invalid file paths. For a well-documented server with many siblings, it could be more 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 0% and the description does not explain the 'file_path' parameter. With low coverage, the description must compensate, but it fails to add any meaning 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 verb 'open' and the resource 'existing workbook' with file type restrictions (.twb or .twbx), and specifies the purpose 'for in-place worksheet editing'. This distinguishes it from sibling tools like 'create_workbook'.
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. It does not mention prerequisites, when-not to use, or differentiate from other editing tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
preview_twb_migrationCInspect
Preview a workbook migration onto a target datasource.
| Name | Required | Description | Default |
|---|---|---|---|
| scope | No | workbook | |
| file_path | Yes | ||
| target_source | Yes | ||
| mapping_overrides | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description lacks behavioral disclosure beyond the vague term 'preview'. It does not state whether the tool modifies data, requires authentication, or what side effects exist. With no annotations, the description must compensate, but it provides minimal 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 a single concise sentence, which is economical but insufficient for a tool with four parameters and zero schema descriptions. It sacrifices necessary information for brevity.
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 (workbook migration preview with an output schema) and many siblings, the description is incomplete. It does not mention the output schema's content, the scope parameter's role, or mapping overrides, leaving an agent without enough context to use 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 description does not explain any of the four schema parameters (scope, file_path, target_source, mapping_overrides). Schema description coverage is 0%, so the description has the burden to add meaning, but it only implies file_path and target_source without details on their format or constraints.
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 verb 'preview' and resource 'workbook migration onto a target datasource', indicating a read-only operation. However, it does not differentiate from siblings like 'profile_twb_for_migration' or 'apply_twb_migration', leaving ambiguity about what 'preview' specifically returns.
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. The description does not mention any prerequisites, scenarios, or circumstances that would make this tool preferable to siblings like 'migrate_twb_guided' or 'propose_field_mapping'.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
profile_csvAInspect
Profile a CSV file before connecting it.
Unlike profile_data_source (which needs an active workbook), this tool profiles a raw CSV file directly.
Args: csv_path: Path to the CSV file. sample_rows: Number of rows to sample for type inference.
Returns: Human-readable DataProfile.
| Name | Required | Description | Default |
|---|---|---|---|
| csv_path | Yes | ||
| sample_rows | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Description states it returns a Human-readable DataProfile and describes parameters, but does not explicitly confirm it is non-destructive. Given no annotations, the description carries the full burden; it implies read-only behavior but could be more explicit about 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?
The description is extremely concise: a one-line summary, a sibling differentiation sentence, and structured Args/Returns. Every sentence is valuable with no waste.
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 presence of an output schema, the description adequately explains return value as a Human-readable DataProfile. Both parameters are covered, and the tool's purpose and usage context are fully addressed.
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 0%, so the description must compensate. It adds meaning for sample_rows ('Number of rows to sample for type inference') beyond the schema title. However, csv_path lacks explanation of format or constraints, leaving some ambiguity.
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 profiles a CSV file before connecting it, using the specific verb 'Profile' and resource 'a CSV file'. It differentiates from profile_data_source by noting that profile_csv works directly on raw CSV files without needing an active workbook.
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 this tool (raw CSV file) and when not (use profile_data_source for an active workbook), with a clear alternative sibling tool named.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
profile_data_sourceAInspect
Profile the currently connected data source.
Works for ANY connection type: CSV extract, Hyper, MySQL, Tableau Server, Excel — anything that has fields in the workbook. The profile includes dimension/measure classification, semantic types, domain hints, and boolean signals that guide chart and template selection.
Args: source_type: Override source detection. Usually "auto" which inspects the workbook fields. Other options: "csv", "hyper" (requires separate file path tools).
Returns: Human-readable DataProfile with signals for template/chart decisions.
| Name | Required | Description | Default |
|---|---|---|---|
| source_type | No | auto |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries full burden. It accurately describes the profiling behavior (read-only) and what the result contains. Does not mention side effects or errors, but for a profiling 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?
Description is concise with a brief overview and structured Args/Returns sections. Front-loaded with main purpose; every sentence adds value 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?
Given output schema exists, the description adequately covers purpose, parameter, and basic return type ('human-readable DataProfile with signals'). Could clarify that it profiles the current active data source, but overall 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?
Though schema coverage is 0%, the description thoroughly explains the single parameter 'source_type', including default 'auto' and other options ('csv', 'hyper'), and notes dependencies. Adds significant value 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?
Clearly states the tool profiles the currently connected data source, works for any connection type, and lists what the profile includes (classification, types, hints, signals). Distinguishes from siblings like profile_csv and profile_twb_for_migration by emphasizing universality.
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?
Describes that it works for ANY connection type and provides examples, and includes a note about 'hyper' requiring separate file path tools. However, does not explicitly state when not to use it or compare to sibling tools like profile_csv.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
profile_twb_for_migrationBInspect
Profile workbook datasources and worksheet scope before migration.
| Name | Required | Description | Default |
|---|---|---|---|
| scope | No | workbook | |
| file_path | Yes | ||
| target_source | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries full burden for behavioral disclosure. It only states the action ('profile') without indicating whether it is read-only, modifies anything, or requires permissions. No side effects or behavioral traits are described.
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 a single 7-word sentence, which is concise but fails to provide sufficient detail for a 3-parameter tool. It is front-loaded but sacrifices completeness.
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 of profiling a workbook for migration, the description lacks essential guidance on parameters and behavior. Though an output schema exists, the description does not leverage it or compensate for missing schema descriptions.
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 has 0% description coverage, and the description only mentions 'worksheet scope' in passing. The parameters 'file_path', 'scope', and 'target_source' are not explained, leaving their meaning and usage unclear.
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 uses a specific verb 'profile' and identifies the resource 'workbook datasources and worksheet scope', clearly distinguishing it from sibling tools like 'analyze_twb' and 'migrate_twb_guided' by indicating it is a pre-migration 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?
The description explicitly states 'before migration', providing clear context for when to use the tool. However, it does not mention when not to use it or provide alternatives among siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
propose_field_mappingCInspect
Scan source and target schema and propose a field mapping.
| Name | Required | Description | Default |
|---|---|---|---|
| scope | No | workbook | |
| file_path | Yes | ||
| target_source | Yes | ||
| mapping_overrides | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries full burden. It says 'scan and propose' implying a read operation, but does not explicitly state it is non-destructive, nor does it mention any side effects, permissions, or rate limits. Minimal behavioral disclosure.
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 a single sentence—concise but lacking necessary detail. It is front-loaded but overly minimal. Every word is earned but sacrifices completeness for brevity.
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, 0% schema coverage, and no annotations, the description is incomplete. An output schema exists but does not compensate for the lack of parameter guidance. An agent would not know how to set required fields like file_path or optional mapping_overrides.
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 0%, meaning the description does not explain any of the 4 parameters (scope, file_path, target_source, mapping_overrides). The description adds no meaning beyond the schema types and names, making it insufficient for correct invocation.
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 scans source and target schema and proposes a field mapping, which is a specific verb and resource. However, it does not explicitly differentiate from sibling tools like 'migrate_twb_guided' or 'diff_template_gap' that also involve field mapping, but the core action is distinct.
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 vs alternatives. The description lacks context on prerequisites, such as needing both schemas accessible, or when to use this versus other mapping-related tools in the sibling list.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
recommend_templateAInspect
Score all gallery templates and recommend the best fit.
Call this AFTER profiling the data source and deciding on chart types, but BEFORE creating the dashboard layout. The decider evaluates every template in the gallery against the data profile and chart mix, returning a ranked list with reasoning.
Args: chart_types: Comma-separated list of chart mark_types being built. Example: "Bar,Line,Text,Text,Map" If omitted, uses only the data profile signals. kpi_count: Override KPI count (else derived from chart_types).
Returns: Ranked template recommendations with scores and reasoning.
| Name | Required | Description | Default |
|---|---|---|---|
| kpi_count | No | ||
| chart_types | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
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 evaluates every template and returns ranked recommendations with reasoning, and implies it is a read-only operation. However, it doesn't mention potential side effects or error conditions, but overall fairly 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 well-structured and concise. It starts with a clear one-line summary, followed by usage context, then parameter details in a code block, and ends with return value description. 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?
Given the tool's complexity and the presence of an output schema, the description sufficiently covers inputs, behavior, and what is returned. It provides context about when to call and parameter handling, making it 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 description adds significant meaning beyond the input schema: chart_types is described as a comma-separated list of mark_types with an example, and kpi_count is an override with derivation logic. This compensates for the 0% schema coverage effectively.
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 scores and recommends gallery templates. It distinguishes itself by specifying it is called after profiling and deciding chart types, which differentiates it from sibling tools like recommend_template_for_csv.
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 when to call: AFTER profiling the data source and deciding on chart types, but BEFORE creating the dashboard layout. Also explains fallback behavior when chart_types is omitted, providing clear usage context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
recommend_template_for_csvAInspect
Recommend templates for a CSV file (no active workbook needed).
Args: csv_path: Path to the CSV file. chart_types: Comma-separated chart types (optional). sample_rows: Rows to sample for inference.
Returns: Ranked template recommendations.
| Name | Required | Description | Default |
|---|---|---|---|
| csv_path | Yes | ||
| chart_types | No | ||
| sample_rows | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description must fully disclose behavior. Only lists parameters and returns, but does not mention if the operation is read-only, any side effects, error handling, or required permissions. Leaves significant gaps.
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?
Very concise: two sentences and a three-line parameter list. Front-loaded with purpose. Every part is necessary and no 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?
An output schema exists but is not visible; description mentions 'Ranked template recommendations' which is sufficient. However, lacks details on edge cases, limitations (e.g., file size), or how to interpret results. Adequate for a simple tool but not comprehensive.
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 0%, so description adds value by naming and briefly explaining each parameter. However, explanations are minimal (e.g., no format for chart_types, no valid values). Does not fully compensate for missing 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?
Clearly states it recommends templates for a CSV file, with the explicit note that no active workbook is needed. Differentiates from sibling tools like 'recommend_template', which likely require a workbook context.
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?
Implies use for standalone CSV files via 'no active workbook needed', but does not explicitly compare to alternatives like 'recommend_template' or state when not to use. No guidance on prerequisites or limitations.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
remove_calculated_fieldCInspect
Remove a previously added calculated field.
| Name | Required | Description | Default |
|---|---|---|---|
| field_name | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description must disclose behavioral traits. It implies a destructive action ('Remove') but does not mention permanence, effects on other fields, required permissions, or error conditions (e.g., field not found).
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 a single sentence without fluff, but it is too terse. It lacks structure (e.g., bullet points or examples) and under-specifies important details, making it minimally adequate.
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?
Although an output schema exists (so return values are covered), the description omits critical context: whether the field must exist, what happens if it doesn't, and any side effects. For a simple removal tool, this is insufficient.
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 description does not elaborate on the 'field_name' parameter. Schema description coverage is 0%, and the description adds no value beyond the parameter's name and type. The tool's lone parameter is left entirely to the schema for explanation.
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: removing a calculated field. It uses a specific verb ('Remove') and resource ('calculated field'), and distinguishes it from sibling tools like 'add_calculated_field' or 'repair_calc_fields'.
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 (e.g., when should one remove a calculated field rather than repair it). There is no mention of prerequisites or context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
repair_calc_fieldsAInspect
Fix role/datatype mismatches on calculated fields in the open workbook.
Demotes string-typed calculations that carry role="measure" to
role="dimension" (with type="nominal"). Use this after
:func:open_workbook when the sidebar shows red ! markers on KPI
label calcs. Call :func:save_workbook afterwards to persist the fix.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden. It discloses the exact transformation (demoting measures to dimensions for string-typed calculations) and implies modification of the open workbook. 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?
Three sentences efficiently convey the purpose, specific transformation, and usage sequence. Every sentence adds value, front-loaded with the primary 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 no parameters and the presence of an output schema, the description is complete. It explains trigger conditions, the fix action, and the need to save. 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?
The input schema has no parameters, so the description provides all necessary context about the tool's action. There are no parameters to document, and the description compensates well.
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 fixes role/datatype mismatches on calculated fields, specifically demoting string-typed measures to dimensions. This is a specific verb+resource and distinguishes it from sibling tools like validate_calc_fields or remove_calculated_field.
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 context: use after open_workbook when red '!' markers appear on KPI label calcs, and call save_workbook afterwards. It does not explicitly state when not to use, but the context is clear enough for an agent to decide.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
reset_rulesAInspect
Reset all rules to the built-in defaults.
Discards any runtime changes made via set_rule() and reloads the default rules from the package YAML file.
Returns: Confirmation message.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description bears full responsibility for behavioral disclosure. It states the tool discards runtime changes and reloads defaults, which is transparent for a destructive operation. It does not mention side effects or reversibility, but given the simplicity, it 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 extremely concise with three sentences: purpose, action, return value. It is front-loaded with the main purpose, and every sentence adds value 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?
For a simple parameterless tool, the description covers all essential aspects: what it does, what it discards, and the return type. The presence of an output schema reduces the need to detail return values. Minor gaps like permission requirements are acceptable given the tool's simplicity.
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 zero parameters, and schema description coverage is 100%. The description appropriately does not add parameter information, as none exist. The baseline for zero parameters is 4.
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 resets all rules to built-in defaults, distinguishing it from sibling tools like set_rule which modify rules individually. The verb 'reset' and resource 'rules' 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 notes that it discards runtime changes made via set_rule(), indicating when to use this tool (to revert changes). It lacks explicit when-not-to-use guidance or alternatives, but the context is clear for a simple reset operation.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
save_workbookBInspect
Save the workbook as a TWB file. Use a .twbx extension to produce a packaged workbook (ZIP) that bundles the XML with any data extracts and images carried over from the source .twbx.
| Name | Required | Description | Default |
|---|---|---|---|
| output_path | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Without annotations, the description should fully disclose behavior. It mentions the .twbx bundling behavior but omits critical details: whether it overwrites existing files, requires a loaded workbook, or has any side effects. The phrase 'carried over from the source .twbx' is ambiguous.
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 main action and key variant info. Every word adds value; 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 the tool's simplicity (1 param, no annotations, output schema present but not described), the description covers the basic purpose and extension behavior. However, it lacks mention of prerequisites, return value, or error conditions, leaving some 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?
The schema has one parameter (output_path) with no description (0% coverage). The description adds meaning by specifying the expected extensions (.twb and .twbx), which helps the agent format the path correctly. However, it doesn't explain other constraints like write permissions or path existence.
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 'Save' and the resource 'workbook as a TWB file', and explains the distinction between .twb and .twbx extensions. However, it does not explicitly differentiate from other save-like actions like 'save as' or saving after modifications, but the purpose is specific enough.
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 the many siblings (e.g., open_workbook, create_workbook, undo_last_change). There is no mention of prerequisites like having an opened workbook or 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.
set_hyper_connectionBInspect
Configure the workbook datasource to use a local Hyper extract connection.
| Name | Required | Description | Default |
|---|---|---|---|
| tables | No | ||
| filepath | Yes | ||
| table_name | No | Extract |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must fully convey behavioral traits. It only states the action without detailing side effects (e.g., replacing existing connection), required permissions, or what happens to existing data. This is insufficient for a mutation 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?
The description is a single sentence with no superfluous words. It is concise and to the point.
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 having 3 parameters and an output schema, the description does not mention return values or complete behavioral context. It is too brief to be fully actionable.
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 0%, and the description adds no meaning to the three parameters (filepath, tables, table_name). The agent receives no guidance on what these parameters represent or how to use them.
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: configure the workbook datasource to use a local Hyper extract connection. The verb 'configure' and resource 'workbook datasource' are specific, and it naturally distinguishes from sibling tools like set_mssql_connection or set_mysql_connection.
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 a Hyper extract connection is needed but provides no explicit guidance on when to use this tool versus alternatives, no prerequisites, and no when-not-to-use conditions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
set_mssql_connectionCInspect
Configure the workbook datasource to use a Microsoft SQL Server connection.
| Name | Required | Description | Default |
|---|---|---|---|
| port | No | 1433 | |
| dbname | Yes | ||
| username | Yes | ||
| table_name | Yes | ||
| server_host | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations exist; the description must solely disclose behavior. It only says 'configure' without detailing side effects (e.g., overwrites existing connection, authentication requirements, or if the workbook must be open). This is insufficient.
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 a single sentence but is under-specified. Conciseness should not sacrifice necessary information; here it omits critical details, making it inadequate rather than 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?
Despite an output schema existing, the description fails to explain prerequisites, scope (e.g., affects current workbook only), or behavior when connection already exists. For a configuration tool with many parameters, this is incomplete.
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 5 parameters with 0% description coverage. The description adds no explanation of parameters beyond the schema titles. Required parameters like server_host, dbname, username, table_name are not described, leaving the agent uninformed.
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 'Configure', the resource 'workbook datasource', and the target 'Microsoft SQL Server connection'. It effectively distinguishes from sibling tools like set_hyper_connection or set_mysql_connection by specifying the database 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?
No guidance is provided on when to use this tool vs. alternatives. There are many sibling connection tools, and the description offers no context, prerequisites, or usage scenarios.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
set_mysql_connectionCInspect
Configure the workbook datasource to use a local MySQL connection.
| Name | Required | Description | Default |
|---|---|---|---|
| port | No | 3306 | |
| dbname | Yes | ||
| server | Yes | ||
| username | Yes | ||
| table_name | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden. It only says 'configure', but does not disclose whether it overwrites existing connections, validates inputs, or has side effects. Safety and behavioral traits are entirely absent.
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 a single sentence, which is concise, but it is too brief to be informative. It meets the minimum requirement but does not provide enough context to justify its length given 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 5 parameters, no annotations, and an output schema (not described), the description is insufficient. It does not explain return values, error conditions, or the effect on the workbook. Significant gaps for a configuration 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 description coverage is 0%, and the description adds no parameter-specific information. The tool has 5 parameters (server, dbname, username, table_name, port) but the description does not clarify their meaning, format, or relationship. This is a critical gap.
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 'configure', the resource 'workbook datasource', and the target 'local MySQL connection'. It distinguishes this tool from sibling connection tools like set_mssql_connection and set_hyper_connection.
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 usage guidance is provided. The description does not indicate when to use this tool vs alternatives, nor any prerequisites or conditions. The agent is left without context on when this tool is appropriate.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
set_ruleAInspect
Set a specific rule value in the active dashboard rules.
This allows admins to modify rules at runtime without editing YAML files. Changes persist for the current session and can be exported with export_rules().
Args: section: Rule section name. Options: "kpi" — KPI formatting (font_size, font_color, bold, row_height, max_kpis, default_format) "charts" — Chart defaults (max_charts, theme, bar_top_n, pie_max_slices) "layout" — Layout settings (width, height, background_color, card_background) "bar_chart_rules" — Bar chart enforcement "theme_rules" — Theme enforcement "map_rules" — Map chart enforcement key: The specific setting to change. Examples: "font_size", "max_charts", "theme", "background_color", "default_format" value: New value (string — will be auto-parsed to int/float/bool as needed). Examples: "28", "modern-dark", "#2D2D2D", "true", "$#,##0.00"
Returns: Confirmation of the change or error message.
| Name | Required | Description | Default |
|---|---|---|---|
| key | Yes | ||
| value | Yes | ||
| section | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
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 that changes 'persist for the current session' and returns confirmation/error, but does not mention side effects, permissions, or whether changes are destructive. 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?
The description is well-structured with a clear first sentence, context sentence, and a bulleted Args section. While it could be slightly more concise, it is efficient and easy to scan, earning a high score.
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 and that an output schema exists (though not shown), the description covers purpose, usage, parameters, and return. It could mention error conditions or validation, but overall it is fairly complete for its 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?
With 0% schema description coverage, the description compensates fully. It provides enum-like list for section, examples for key and value, and explains auto-parsing (e.g., 'will be auto-parsed to int/float/bool as needed'). This adds substantial meaning beyond the bare 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 'Set a specific rule value in the active dashboard rules' and distinguishes this from sibling tools like get_active_rules (read) and export_rules (export). The verb and resource are specific and the context of modifying runtime rules is clear.
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 'at runtime without editing YAML files' and that changes can be exported, but does not explicitly guide when to use this versus alternatives like reset_rules or when not to use it. The usage context is implied but lacks explicit when-to-use or exclusionary guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
set_tableauserver_connectionCInspect
Configure the workbook datasource to use a Tableau Server connection.
| Name | Required | Description | Default |
|---|---|---|---|
| port | No | 82 | |
| dbname | Yes | ||
| server | Yes | ||
| username | Yes | ||
| directory | No | /dataserver | |
| table_name | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries full responsibility for behavioral disclosure. It is extremely brief and does not mention whether the connection overwrites existing ones, requires authentication, or has side effects on other datasources. The presence of an output schema is noted but not explained.
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 a single sentence, which is concise but at the expense of necessary detail. It is suitably front-loaded for purpose but lacks structure for parameters and usage context.
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 six parameters, a clear sibling context, and an output schema, the description is severely incomplete. It does not explain return values, prerequisites, or the effect on the workbook. Far from meeting the information needs of an AI 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 description coverage is 0%, and the description adds no meaning to the parameters. For example, 'port', 'dbname', 'server', 'username', 'directory', and 'table_name' are all listed in the schema but not explained in the description. The description only mentions the overall purpose.
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 configures a workbook datasource to use a Tableau Server connection. The verb and resource are specific, and the tool name itself differentiates it from siblings like set_hyper_connection. However, it does not explicitly contrast with other set_*_connection tools.
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. While the server type is implied by the name, the description does not mention prerequisites, such as having an existing workbook open, or when another connection type should be chosen.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
suggest_charts_for_csvAInspect
Suggest chart types and configurations for a CSV file.
Analyzes the data shape (dimensions, measures, temporal fields, etc.) and returns prioritized chart suggestions with shelf assignments.
Args: csv_path: Path to the CSV file. max_charts: Maximum number of charts to suggest (0 = use dashboard_rules.yaml default). sample_rows: Rows to sample for inference. rules_yaml: Optional YAML string with dashboard rules overrides (e.g. KPI formatting, chart limits).
Returns: Formatted suggestion list with chart types, shelf assignments, and reasoning.
| Name | Required | Description | Default |
|---|---|---|---|
| csv_path | Yes | ||
| max_charts | No | ||
| rules_yaml | No | ||
| sample_rows | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are present, so the description carries full burden. It mentions analysis of data shape and returns prioritized suggestions, but does not disclose if the tool is read-only, requires special permissions, or has side effects. Behavioral insights are moderate 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?
The description is fairly concise with a front-loaded purpose sentence and an efficient Args block. Each sentence adds value, though the Args section could be slightly shortened or moved to a separate line.
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 presence of an output schema, the description adequately covers the return value (formatted suggestion list) without needing to detail it. The description addresses input, processing, and output, leaving minor gaps in behavioral and 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?
The description includes an Args section that explains each parameter (csv_path, max_charts, sample_rows, rules_yaml), adding meaning beyond the schema which has 0% coverage. This fully compensates for the lack of 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 suggests chart types and configurations for a CSV file, specifying the resource (CSV) and action (suggest charts). It distinguishes itself from sibling tools like csv_to_dashboard (full dashboard creation) and inspect_csv (data inspection).
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 chart suggestions from CSV data but does not explicitly state when to use this tool versus alternatives like csv_to_dashboard or recommend_template. No when-not or exclusion criteria are provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
undo_last_changeBInspect
Undo the last mutating operation, restoring the previous workbook state.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description must disclose behaviors. It states undo and restore, but omits details like whether the tool itself is mutating, what happens if no prior operation, and if undo is limited to one step.
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 sentence, no wasted words, action verb front-loaded. Could include more context without being overly verbose.
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 is minimal for a tool with no output schema. It does not explain return value, undo depth, session scope, or error states (e.g., no changes to undo).
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?
Zero parameters and 100% schema coverage, baseline is 3. Description adds no parameter info, but none is needed.
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 undoes the last mutating operation and restores previous state, with a specific verb and resource. It distinguishes from all sibling tools, which are creation or modification tools.
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?
Usage is implied (undo after mutation), but no explicit guidance on when to use or not, no limitations mentioned (e.g., only one undo level, persistent across sessions), and no alternatives provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
validate_calc_fieldsAInspect
Scan open workbook for role/datatype mismatches on calculated fields.
Catches the common failure mode where a string-typed calculation ships
with role="measure". Tableau cannot aggregate a string, so the field
shows a red ! in the Data pane and any SUM/AVG/ATTR reference to it
is rejected with "can't be converted to a measure using ATTR()".
This is a read-only check. To fix detected issues in place call
:func:repair_calc_fields.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description discloses that the tool is read-only, scans open workbook, and explains the failure mode. However, it does not mention prerequisites like requiring an open workbook, though that is implied. Overall, it provides good behavioral context beyond the lack of annotations.
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 short paragraphs, front-loading the essential purpose. Every sentence adds value, with no redundant or unclear language.
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 are no input parameters and an output schema exists, the description covers all necessary aspects: purpose, usage guidelines, behavioral transparency, and alternatives. It is fully informative for an AI 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?
No parameters are defined, so the description does not need to add parameter-specific information. The schema coverage is 100% (trivially), and the description focuses on behavior rather than parameters, which 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 scans open workbooks for role/datatype mismatches on calculated fields, specifically catching string-typed calculations with role='measure'. It uses a specific verb 'scan' and resource 'open workbook', and distinguishes itself from sibling tools like repair_calc_fields.
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 states it is a read-only check and directs users to call repair_calc_fields to fix detected issues. Also explains the common failure mode and its consequences, providing clear context on when to use this tool versus the alternative.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
validate_workbookAInspect
Run an informational XSD schema check on a workbook (2026.1 schema).
This is a non-blocking, advisory check only. Tableau Desktop is the true validator — it routinely produces workbooks that deviate from the published XSD schema, so deviations reported here do NOT indicate the workbook is broken. The workbook will almost certainly open correctly in Tableau regardless of any deviations found.
Args: file_path: Path to a .twb or .twbx file to check. If omitted, checks the currently open workbook (in memory).
Returns: Informational summary of schema deviations (if any).
| Name | Required | Description | Default |
|---|---|---|---|
| file_path | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries full burden and does well: it states the tool is 'non-blocking, advisory only', explains the relationship with Tableau Desktop's validation, and describes the return as an 'informational summary'. It lacks mention of performance or side effects, but the non-destructive nature is clear.
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 front-loaded with the core purpose, followed by behavioral notes and then structured args/returns. It is slightly verbose with the analogies about Tableau Desktop, but still concise overall.
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 one optional parameter and no annotations, the description covers purpose, behavior, parameter semantics, and return value. An output schema exists, so detailed return info is not expected. The description is complete for the tool's simplicity.
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 zero descriptions (0% coverage), so the description must compensate. It explicitly explains the optional file_path parameter: 'If omitted, checks the currently open workbook (in memory).' This adds significant meaning 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 'Run an informational XSD schema check on a workbook (2026.1 schema).' This specific verb+resource combination and the mention of the schema version distinguish it from sibling tools like validate_calc_fields.
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 usage context by noting the check is non-blocking and advisory, and that deviations do not indicate the workbook is broken. However, it does not explicitly contrast with alternative validation tools like validate_calc_fields, leaving some ambiguity about when to use each.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Claim this connector by publishing a /.well-known/glama.json file on your server's domain with the following structure:
{
"$schema": "https://glama.ai/mcp/schemas/connector.json",
"maintainers": [{ "email": "your-email@example.com" }]
}The email address must match the email associated with your Glama account. Once published, Glama will automatically detect and verify the file within a few minutes.
Control your server's listing on Glama, including description and metadata
Access analytics and receive server usage reports
Get monitoring and health status updates for your server
Feature your server to boost visibility and reach more users
For users:
Full audit trail – every tool call is logged with inputs and outputs for compliance and debugging
Granular tool control – enable or disable individual tools per connector to limit what your AI agents can do
Centralized credential management – store and rotate API keys and OAuth tokens in one place
Change alerts – get notified when a connector changes its schema, adds or removes tools, or updates tool definitions, so nothing breaks silently
For server owners:
Proven adoption – public usage metrics on your listing show real-world traction and build trust with prospective users
Tool-level analytics – see which tools are being used most, helping you prioritize development and documentation
Direct user feedback – users can report issues and suggest improvements through the listing, giving you a channel you would not have otherwise
The connector status is unhealthy when Glama is unable to successfully connect to the server. This can happen for several reasons:
The server is experiencing an outage
The URL of the server is wrong
Credentials required to access the server are missing or invalid
If you are the owner of this MCP connector and would like to make modifications to the listing, including providing test credentials for accessing the server, please contact support@glama.ai.
Discussions
No comments yet. Be the first to start the discussion!
Your Connectors
Sign in to create a connector for this server.