Skip to main content
Glama

prismic_get_refs

Retrieve repository version pointers like master or preview refs from Prismic Content API. Use these refs with document reading tools to access specific content versions efficiently.

Instructions

Get repository refs from Content API root.

Refs are repository-level version pointers (for example master, preview, or release refs), not per-document refs. Use returned ref values with prismic_get_documents or prismic_get_document to read content for that version pointer. Efficiency tip: call once, cache the chosen ref, and pass it explicitly to subsequent read calls to avoid per-call implicit master-ref resolution.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The core logic function for prismic_get_refs, which uses a service to fetch refs and returns them in a dict.
    async def handle_prismic_get_refs(
        *,
        service_factory: ServiceFactory = _build_service,
    ) -> dict[str, Any]:
        """Return repository-level refs from Prismic Content API root (`/api/v2`)."""
    
        async with service_factory() as service:
            refs = await service.get_refs()
    
        return {"refs": refs}
  • The MCP tool decorator registration for prismic_get_refs.
    @server.tool(name="prismic_get_refs")
    async def prismic_get_refs() -> dict[str, Any]:
        """Get repository refs from Content API root.
    
        Refs are repository-level version pointers (for example `master`,
        preview, or release refs), not per-document refs.
        Use returned `ref` values with `prismic_get_documents` or
        `prismic_get_document` to read content for that version pointer.
        Efficiency tip: call once, cache the chosen `ref`, and pass it explicitly
        to subsequent read calls to avoid per-call implicit master-ref resolution.
        """
    
        return await handle_prismic_get_refs()
Behavior4/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 effectively describes the tool's behavior: it returns refs for use with other tools, implies it's a read operation (consistent with 'Get'), and includes an efficiency tip about caching to optimize performance. However, it doesn't mention potential errors, rate limits, or authentication needs, leaving some gaps.

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 well-structured and concise, with three focused paragraphs: the first states the purpose, the second clarifies what refs are and links to siblings, and the third provides an efficiency tip. Every sentence adds value without waste, and it's front-loaded with key information.

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

Completeness5/5

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

Given the tool's simplicity (0 parameters, no annotations, but has an output schema), the description is complete. It explains what the tool does, how to use the output, and includes performance advice. With an output schema present, it doesn't need to detail return values, making this description fully adequate for the context.

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?

The tool has 0 parameters, and schema description coverage is 100%, so no parameter documentation is needed. The description appropriately focuses on the tool's purpose and usage without redundant parameter details, earning a baseline score of 4 for zero-parameter tools.

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 specific action ('Get repository refs from Content API root') and distinguishes it from siblings by explaining what refs are (repository-level version pointers) and what they are not (per-document refs). It uses precise terminology like 'master', 'preview', or 'release refs' to clarify scope.

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

Usage Guidelines5/5

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

The description explicitly states when to use this tool (to get refs for version pointers) and how to use the output with sibling tools like 'prismic_get_documents' or 'prismic_get_document'. It also provides an efficiency tip on caching the ref to avoid per-call resolution, offering clear operational guidance.

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/rahulpowar/prismic-content-mcp'

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