Skip to main content
Glama

get_block_document

Retrieve detailed information about a specific Prefect block document using its unique identifier to access configuration and settings for workflow automation components.

Instructions

Get a block document by ID.

Args: block_document_id: The block document UUID

Returns: Block document details

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
block_document_idYes

Implementation Reference

  • The main handler function for the 'get_block_document' MCP tool. It is decorated with @mcp.tool, which registers it. The function fetches a Prefect block document by its UUID using the Prefect client and returns its details as text content.
    @mcp.tool
    async def get_block_document(
        block_document_id: str,
    ) -> List[Union[types.TextContent, types.ImageContent, types.EmbeddedResource]]:
        """
        Get a block document by ID.
        
        Args:
            block_document_id: The block document UUID
            
        Returns:
            Block document details
        """
        async with get_client() as client:
            block_document = await client.read_block_document(UUID(block_document_id))
            
            return [types.TextContent(type="text", text=str(block_document.model_dump()))]
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. It mentions retrieving details but doesn't specify whether this is a read-only operation, what permissions are required, error handling (e.g., for invalid IDs), or response format details. This leaves significant gaps for a tool that interacts with data.

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 front-loaded with the core purpose in the first sentence, followed by brief but clear sections for Args and Returns. Every sentence adds value without redundancy, making it 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 low complexity (1 parameter, no output schema, no annotations), the description is minimally adequate. It covers the basic purpose and parameter but lacks details on usage context, behavioral traits, and output specifics, which could hinder effective agent 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?

Schema description coverage is 0%, but the description compensates by explaining that 'block_document_id' is a UUID for identifying the specific block document. This adds meaningful context beyond the schema's basic type information, though it doesn't detail format constraints or examples.

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 action ('Get') and resource ('block document by ID'), making the purpose immediately understandable. However, it doesn't differentiate from its sibling 'get_block_documents' (plural), which appears to retrieve multiple documents rather than a single one by ID.

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?

No guidance is provided on when to use this tool versus alternatives like 'get_block_documents' or other retrieval tools in the sibling list. The description only states what it does without context about appropriate use cases or prerequisites.

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/allen-munsch/mcp-prefect'

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