Skip to main content
Glama
PiwikPRO

Piwik PRO MCP Server

Official
by PiwikPRO
OverviewSchemaRelated ServersScoreDiscussions
Python
Remote

analytics_custom_dimensions_get

Read-only

Retrieve a specific custom dimension by its ID. Provide the dimension ID, website ID, and scope (session, event, or product) to get the dimension details.

Instructions

    Get a specific custom dimension by ID.

    Note: The scope parameter is required to determine which API to query.
    If you don't know the scope, use analytics_custom_dimensions_list() first
    to find the dimension and its scope.

    Args:
        dimension_id: Custom Dimension UUID
        website_id: Website/App UUID
        scope: Dimension scope (required for API routing):
               - "session" or "event": Query standard custom dimensions API
               - "product": Query product custom dimensions API

    Returns:
        CustomDimensionItem (for session/event) or ProductCustomDimensionItem (for product)

    Raises:
        RuntimeError: If dimension not found or API request fails

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dimension_idYes
website_idYes
scopeYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Tool Definition Quality

A5/5.0
Behavior5/5

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

Discloses RuntimeError for failures and different return types per scope, adding value beyond the readOnlyHint annotation.

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

Conciseness5/5

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

Well-structured with sections for note, args, returns, raises; each sentence is informative and earns its place.

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

Completeness5/5

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

Covers all necessary details for a 3-param tool with output schema; no gaps remain.

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

Parameters5/5

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

With 0% schema coverage, the description fully explains each parameter (UUIDs, enum values, routing effects), compensating completely.

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

Purpose5/5

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

The description clearly states it gets a custom dimension by ID and explains the scope-based API routing. It is distinct from siblings like list and get_slots.

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

Usage Guidelines5/5

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

Explicitly advises using list() first if scope is unknown, providing clear when-to-use guidance and an alternative.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/PiwikPRO/mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server