Skip to main content
Glama
Sign In

Spaces by Peakflo

by ai.peakflo
OverviewDiscussionsAdmin

report_custom_dimension_upsert

Destructive

Add or update one tenant custom report property on a virtual Business Context entity type.

The tool preserves existing custom dimensions and only replaces the dimension with the same key. It creates a tenant-scoped override when the target type is a system definition.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "key": "<key>",
      "label": "<label>",
      "type": "<type>"
    },
    "name": "report_custom_dimension_upsert"
  }
}

Input Schema

NameRequiredDescriptionDefault
keyYesDimension key, e.g. is_intercompany
sqlNoSafe scalar SQL expression over the bound view columns
typeYesCube dimension type
viewNoAnalytics view to update, e.g. customers, vendors, chart_of_accounts
labelYesHuman label, e.g. Intercompany
entity_typeNoEntity type to update, e.g. customer, vendor, gl_account
entity_type_idNoExact entity type definition ID to update
custom_field_nameNoLegacy shorthand: extract this custom field name from custom_fields

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior4/5

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

Annotations flag destructiveHint=true and readOnlyHint=false, and the description adds real value beyond them by explaining exactly what is overwritten: existing custom dimensions are preserved, only the dimension with the same key is replaced, and a tenant-scoped override is created for system definitions. That is precisely the kind of blast-radius detail an agent needs before calling a destructive mutation. It stops short of describing return values or validation failures.

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

Conciseness4/5

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

Three short, front-loaded sentences with no filler; the upsert behavior leads and the preservation/override semantics follow. The phrase 'virtual Business Context entity type' is domain jargon left unexplained, which slightly reduces accessibility but costs no length.

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

Completeness3/5

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

For an 8-parameter destructive mutation with no output schema, the description covers overwrite behavior but leaves key operational gaps: it never explains how view, entity_type, entity_type_id, and custom_field_name relate or which combination is required, nor what the tool returns. Adequate but not complete for a tool of this complexity.

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

Parameters3/5

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

Schema description coverage is 100%, so every parameter is already documented with examples, including the key pattern and SQL expression semantics. The description adds no parameter-level meaning beyond referring to 'the dimension with the same key' and 'the target type', so the baseline 3 applies.

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

Purpose4/5

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

The description states a specific verb and resource: 'Add or update one tenant custom report property on a virtual Business Context entity type.' That is far more informative than the tool name alone and clearly places it in the custom-dimension family. It does not explicitly distinguish itself from siblings such as report_custom_dimension_delete or report_custom_dimensions_list, relying on the name for that separation.

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

Usage Guidelines3/5

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

The upsert semantics imply when to use it (to add a new dimension or replace one by key), and the note about tenant-scoped overrides for system definitions helps. However, there is no explicit when-to-use/when-not guidance relative to the delete/list siblings, and nothing about prerequisites or which alternative to reach for when only inspecting dimensions.

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

All Spaces by Peakflo toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources