Skip to main content
Glama
PiwikPRO

Piwik PRO MCP Server

Official
by PiwikPRO

apps_get

Read-only

Retrieve detailed analytics configuration for a specific Piwik PRO app, including settings like URLs, timezone, currency, and GDPR compliance.

Instructions

Get detailed information about a specific app.

    Args:
        app_id: UUID of the app to retrieve

    Returns:
        Dictionary containing detailed app information including:
        - id: App UUID
        - name: App name
        - urls: List of URLs where the app is available
        - app_type: Type of application
        - timezone: App timezone
        - currency: App currency
        - gdpr_enabled: Whether GDPR is enabled
        - gdpr_data_anonymization: Whether GDPR data anonymization is enabled
        - real_time_dashboards: Whether real-time dashboards are enabled
        - created_at: App creation datetime
        - updated_at: App last update datetime

    For more details use also get_app_tracker_settings tool.
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
app_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesApp UUID
nameYesApp name
urlsYesList of URLs where the app is available
app_typeNoType of application
currencyNoApp currency
timezoneNoApp timezone
created_atNoCreation timestamp
updated_atNoLast update timestamp
gdpr_enabledNoWhether GDPR is enabled
real_time_dashboardsNoReal-time dashboards enabled
gdpr_data_anonymizationNoGDPR data anonymization setting

Implementation Reference

  • The MCP tool handler function 'apps_get' decorated with @mcp.tool, implementing the tool by delegating to get_app_details(app_id). This is the exact implementation of the tool named "apps_get".
    @mcp.tool(annotations={"title": "Piwik PRO: Get App", "readOnlyHint": True})
    def apps_get(app_id: str) -> AppDetailsMCPResponse:
        """Get detailed information about a specific app.
    
        Args:
            app_id: UUID of the app to retrieve
    
        Returns:
            Dictionary containing detailed app information including:
            - id: App UUID
            - name: App name
            - urls: List of URLs where the app is available
            - app_type: Type of application
            - timezone: App timezone
            - currency: App currency
            - gdpr_enabled: Whether GDPR is enabled
            - gdpr_data_anonymization: Whether GDPR data anonymization is enabled
            - real_time_dashboards: Whether real-time dashboards are enabled
            - created_at: App creation datetime
            - updated_at: App last update datetime
    
        For more details use also get_app_tracker_settings tool.
        """
        return get_app_details(app_id)
  • Pydantic model defining the output response schema for the apps_get tool.
    class AppDetailsMCPResponse(BaseModel):
        """MCP-specific app details response that matches documented schema."""
    
        id: str = Field(..., description="App UUID")
        name: str = Field(..., description="App name")
        urls: List[str] = Field(..., description="List of URLs where the app is available")
        app_type: Optional[str] = Field(None, description="Type of application")
        timezone: Optional[str] = Field(None, description="App timezone")
        currency: Optional[str] = Field(None, description="App currency")
        gdpr_enabled: Optional[bool] = Field(None, description="Whether GDPR is enabled")
        gdpr_data_anonymization: Optional[bool] = Field(None, description="GDPR data anonymization setting")
        real_time_dashboards: Optional[bool] = Field(None, description="Real-time dashboards enabled")
        created_at: Optional[datetime] = Field(None, description="Creation timestamp")
        updated_at: Optional[datetime] = Field(None, description="Last update timestamp")
  • Supporting helper function containing the core logic for fetching and mapping app details from the Piwik PRO API client.
    def get_app_details(app_id: str) -> AppDetailsMCPResponse:
        try:
            client = create_piwik_client()
            response = client.apps.get_app(app_id)
    
            app_data = response["data"]
            attrs = app_data["attributes"]
    
            return AppDetailsMCPResponse(
                id=app_data["id"],
                name=attrs["name"],
                urls=attrs["urls"],
                app_type=attrs.get("appType"),
                timezone=attrs.get("timezone"),
                currency=attrs.get("currency"),
                gdpr_enabled=attrs.get("gdpr"),
                gdpr_data_anonymization=attrs.get("gdprDataAnonymization"),
                real_time_dashboards=attrs.get("realTimeDashboards"),
                created_at=attrs.get("addedAt"),
                updated_at=attrs.get("updatedAt"),
            )
    
        except NotFoundError:
            raise RuntimeError(f"App with ID {app_id} not found")
        except Exception as e:
            raise RuntimeError(f"Failed to get app details: {str(e)}")
  • Registration call to register_app_tools(mcp) within register_all_tools, which defines and registers the apps_get tool.
    register_app_tools(mcp)
Behavior3/5

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

Annotations provide 'readOnlyHint: true', indicating it's a safe read operation. The description adds value by specifying it returns 'detailed information' and lists specific fields in the return dictionary, which goes beyond the annotations. However, it does not disclose other behavioral traits like error handling, rate limits, or authentication needs. No contradiction with annotations exists.

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?

The description is well-structured and front-loaded with the main purpose. It efficiently uses bullet points to detail return values and includes a note about an alternative tool without unnecessary verbosity. Every sentence adds value, making it appropriately concise.

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?

Given the tool's simplicity (1 parameter, read-only operation with annotations, and an output schema implied by the return description), the description is complete. It explains the purpose, parameter, return values, and references an alternative tool, covering all necessary aspects without redundancy.

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

Parameters4/5

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

The input schema has 1 parameter with 0% description coverage, so the description must compensate. It clearly explains 'app_id' as 'UUID of the app to retrieve', adding essential semantic context that the schema lacks. This adequately covers the single parameter, though it could mention format or validation details.

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 clearly states the tool's purpose: 'Get detailed information about a specific app.' It specifies the verb ('Get') and resource ('app'), but does not explicitly differentiate it from sibling tools like 'apps_list' or 'apps_update'. The purpose is clear but lacks sibling distinction.

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

Usage Guidelines4/5

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

The description provides clear context for usage: it's for retrieving details of a specific app identified by UUID. It mentions an alternative tool ('get_app_tracker_settings') for more details, but does not specify when to use this tool versus other siblings like 'apps_list' or 'apps_get' from the context. The guidance is helpful but not comprehensive for all alternatives.

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