Skip to main content
Glama
aptro

Superset MCP Integration

by aptro

superset_explore_permalink_get

Retrieve saved chart exploration states in Apache Superset using permalink keys to restore previous analysis configurations.

Instructions

Get a permalink for chart exploration

Makes a request to the /api/v1/explore/permalink/{key} endpoint to retrieve a previously saved exploration state.

Args: key: Key of the permalink to retrieve

Returns: A dictionary with the stored exploration state

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
keyYes

Implementation Reference

  • Handler function implementing the superset_explore_permalink_get tool. Retrieves a saved chart exploration permalink state from Superset using the provided key by calling the Superset API endpoint /api/v1/explore/permalink/{key}.
    @mcp.tool()
    @requires_auth
    @handle_api_errors
    async def superset_explore_permalink_get(ctx: Context, key: str) -> Dict[str, Any]:
        """
        Get a permalink for chart exploration
    
        Makes a request to the /api/v1/explore/permalink/{key} endpoint to retrieve
        a previously saved exploration state.
    
        Args:
            key: Key of the permalink to retrieve
    
        Returns:
            A dictionary with the stored exploration state
        """
        return await make_api_request(ctx, "get", f"/api/v1/explore/permalink/{key}")
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the tool retrieves data via an API endpoint, implying a read-only operation, but doesn't specify authentication requirements, rate limits, error handling, or whether it's idempotent. For a tool with zero annotation coverage, this is insufficient to inform safe and effective use.

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?

The description is well-structured and concise, with a clear purpose statement followed by API endpoint details, args, and returns. Each sentence adds value without redundancy. It could be slightly more front-loaded by emphasizing the retrieval action earlier, but overall it's efficient and easy to parse.

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?

Given the tool's moderate complexity (single parameter, no output schema, no annotations), the description is minimally adequate. It covers the basic purpose and parameter but lacks behavioral context, usage guidelines, and output details. Without annotations or an output schema, the agent must infer missing information, making this description incomplete for reliable tool invocation.

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 0%, but the description compensates by explaining the single parameter: 'key: Key of the permalink to retrieve.' This adds meaning beyond the schema's basic type definition. However, it doesn't provide examples, format details, or constraints (e.g., where the key comes from), leaving some ambiguity. With one parameter and partial compensation, a baseline 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 clearly states the tool's purpose: 'Get a permalink for chart exploration' and 'retrieve a previously saved exploration state.' It specifies the verb ('Get', 'retrieve'), resource ('permalink', 'exploration state'), and scope ('previously saved'), making it unambiguous. However, it doesn't explicitly differentiate from sibling tools like 'superset_explore_permalink_create', which is a minor gap.

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 description provides no guidance on when to use this tool versus alternatives. It mentions retrieving a 'previously saved exploration state' but doesn't clarify prerequisites (e.g., needing a saved permalink first) or compare it to related tools like 'superset_explore_form_data_get'. This leaves the agent without context for tool selection.

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/aptro/superset-mcp'

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