Skip to main content
Glama

add_bookmark

Create a report-level bookmark that captures a page's view state by hiding specified visuals and showing the rest, returning the bookmark name for button wiring.

Instructions

Add a report-level bookmark that captures a page's visualContainers with the listed visuals HIDDEN and the rest shown (the view-state pattern). Names it 'Bookmark'+16 hex. hiddenVisuals = comma-separated visual ids (from list_visuals). Returns the new bookmark name. Wire it to a button with add_action_button.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageYespage name or displayName the bookmark captures
captureDataNoalso capture the live DATA state (filter/slicer values, sort, drill, cross-highlight) - not just which visuals show
displayNameYesbookmark title shown in the pane
hiddenVisualsNocomma-separated visual ids to hide (the rest are shown)
reportSessionIdYes
Behavior4/5

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

With no annotations, the description carries the full burden and discloses the auto-generated name format 'Bookmark'+16 hex, the hidden/rest-shown behavior, the return of the new bookmark name, and a follow-up wiring suggestion. It doesn't cover permissions or explain the relationship between generated name and displayName, but covers most key behavioral traits.

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?

Three dense, front-loaded sentences convey the core action, naming scheme, parameter format, return value, and usage tip without any fluff. Every sentence adds value.

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

Completeness4/5

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

For a tool with no output schema, the description covers purpose, behavior, parameters, return value, and integration. Minor gaps remain around reportSessionId context and error handling, but the essential operational flow is well-covered.

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?

Schema covers 80% of parameters. The description adds meaningful semantics by specifying hiddenVisuals as comma-separated IDs from list_visuals, clarifying the 'rest shown' default, and revealing the naming mechanism not present in the schema. However, reportSessionId remains undocumented and displayName interplay is ambiguous.

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 the tool adds a report-level bookmark with a specific view-state pattern, hiding listed visuals and showing the rest. The verb 'add', resource 'bookmark', and detailed behavior distinguish it from siblings like update_bookmark, delete_bookmark, and add_bookmark_navigator.

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 'view-state pattern' phrase and 'Wire it to a button with add_action_button' provide contextual usage guidance. It implies using list_visuals for IDs and contrasts view-state with captureData for data state, but does not explicitly name alternatives or state when not to use this tool.

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/cyphonica/powerbi-pbix-mcp'

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