Skip to main content
Glama

pbi_generate_portal

Regenerate an offline HTML documentation and live lineage portal from the local catalog store, with an option to redact owner and user permission lists for anonymous sharing.

Instructions

Regenerate the offline HTML Documentation & Live Lineage Portal from the local catalog store.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "pbi_generate_portal"
  }
}

Input Schema

NameRequiredDescriptionDefault
anonymousNoRedact owner and user permission lists.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.1/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden. It discloses that the tool regenerates an artifact from a local store, which hints at overwriting an existing portal, but it does not describe file output location, permissions, side effects, or whether the portal must already exist.

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 a single front-loaded sentence with zero wasted words. It immediately states the action and the source data, which is exactly what an agent needs at first glance.

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 a one-parameter generation tool, the description gives the essential purpose and source, but it omits important context such as output location, prerequisite state of the local catalog store, and overwrite behavior. There is no output schema to explain return values, so these gaps remain unaddressed elsewhere.

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?

The schema description coverage is 100%, and the single optional boolean parameter is fully documented in the schema as redacting owner and user permission lists. The description adds no additional meaning about the anonymous parameter. With the schema doing the work, the baseline score of 3 is appropriate.

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 uses a specific verb and resource: it regenerates an offline HTML Documentation & Live Lineage Portal from the local catalog store. That clearly distinguishes the action from sibling query and inspection tools. It does not explicitly name an alternative, but the generation 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.

Usage Guidelines2/5

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

The phrase 'Regenerate' implies this is used to refresh an existing portal artifact, but there is no explicit when-to-use guidance. It does not state prerequisites such as whether the local catalog store must already be populated, nor when an agent should choose this over sibling tools like pbi_catalog_summary.

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