Skip to main content
Glama
umami-compass

umami-compass

by webcredo

Get an Umami website

get_website
Read-onlyIdempotent

Retrieve metadata for a single Umami Analytics website by providing its website UUID, enabling you to inspect site details for configuration and reporting.

Instructions

Get metadata for one website.

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": {
      "websiteId": "<websiteId>"
    },
    "name": "get_website"
  }
}

Input Schema

NameRequiredDescriptionDefault
websiteIdYesUmami UUID

Output Schema

NameRequiredDescriptionDefault
dataYes
metaYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.5.2
    • addedOutput schema / properties / meta / properties / responseTruncated
      Added value: +{
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / meta / properties / sectionsTruncated
      Added value: +{
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • changedOutput schema / properties / meta / required
      Previous value: -[
      -  "dataStatus",
      -  "truncated"
      -]New value: +[
      +  "dataStatus",
      +  "truncated",
      +  "responseTruncated",
      +  "sectionsTruncated"
      +]
  2. First observedv0.4.1

TDQS

C2.7/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=true, so the safety and idempotency profile is fully carried by structured data. The description adds almost nothing beyond that — it does not say what is returned, whether a missing websiteId yields an error or null, or how this differs from a stats fetch. With rich annotations the bar is lower, but this contributes little extra context.

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?

A single, front-loaded sentence with zero filler. It is efficient, but the brevity borders on under-specification rather than crisp conciseness, leaving one short clause of useful scope detail unpaid for.

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?

The tool is simple (one fully documented required parameter), annotations cover the safety profile, and an output schema exists so return values need not be explained. What is missing is the selection context: what "metadata" comprises and why an agent would pick this over get_website_stats or resolve_website. Minimally complete for a simple read, but thin for a family with many near-neighbours.

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?

Only one parameter, websiteId, and schema description coverage is 100% including format, UUID pattern and the "Umami UUID" description. The description adds no meaning beyond the schema, so the baseline of 3 applies; no compensation is needed.

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

Purpose3/5

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

The description states a verb and resource ("Get metadata for one website"), so the basic operation is identifiable. However, "metadata" is never unpacked (name, domain, tracking config, share settings?), and with siblings like get_website_stats and get_website_date_range in the same family, the description does not clarify what distinguishes this retrieval from the analytics-style siblings. Adequate but vague at the edges.

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

Usage Guidelines2/5

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

There is no when-to-use guidance and no mention of alternatives. An agent has no signal about whether to call this first to resolve/validate a website, or whether get_website_stats or resolve_website is the correct entry point. Only implied usage can be inferred from the name.

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