Skip to main content
Glama
fadlee

PocketBase MCP Server

by fadlee

get_collection_schema

Retrieve schema details for a specific PocketBase collection to understand its structure, fields, and data types.

Instructions

Get schema details for a collection

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
collectionYesCollection name

Implementation Reference

  • Creates the ToolHandler for get_collection_schema, which retrieves the full schema details of a specified PocketBase collection using pb.collections.getOne.
    export function createGetCollectionSchemaHandler(pb: PocketBase): ToolHandler {
      return async (args: { collection: string }) => {
        try {
          const result = await pb.collections.getOne(args.collection);
          return createJsonResponse(result);
        } catch (error: unknown) {
          throw handlePocketBaseError("get collection schema", error);
        }
      };
    }
  • JSON Schema defining the input for get_collection_schema tool: requires a 'collection' string parameter.
    export const getCollectionSchemaSchema = {
      type: "object",
      properties: {
        collection: {
          type: "string",
          description: "Collection name",
        },
      },
      required: ["collection"],
    };
  • src/server.ts:106-110 (registration)
    Registers the get_collection_schema tool in the MCP server's tools array, associating its name, description, input schema, and handler.
      name: "get_collection_schema",
      description: "Get schema details for a collection",
      inputSchema: getCollectionSchemaSchema,
      handler: createGetCollectionSchemaHandler(pb),
    },
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 burden of behavioral disclosure. It states the action ('Get') but does not describe traits like whether it's read-only, requires authentication, has rate limits, or what the output format might be. This leaves significant gaps in understanding the tool's behavior beyond the basic action.

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, efficient sentence that directly states the tool's purpose without any wasted words. It is front-loaded and appropriately sized for the tool's complexity, making it easy to understand at a glance.

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

Completeness2/5

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

Given the lack of annotations and output schema, the description is incomplete. It does not address behavioral aspects like authentication needs or output details, which are crucial for a tool that interacts with collections. For a tool with no structured support, more context is needed to be fully helpful.

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 input schema has 100% description coverage, with the parameter 'collection' clearly documented as 'Collection name'. The description adds no additional meaning beyond this, such as examples or constraints, but since the schema provides adequate information, 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 clearly states the verb ('Get') and resource ('schema details for a collection'), making the purpose specific and understandable. However, it does not distinguish this tool from potential siblings like 'generate_pb_schema' or 'generate_typescript_interfaces', which might also relate to schema operations, leaving room for ambiguity in sibling differentiation.

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 does not mention prerequisites, context, or exclusions, such as whether it should be used before creating records or after migrating a collection, nor does it reference sibling tools like 'list_collections' for obtaining collection names.

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/fadlee/dynamic-pocketbase-mcp'

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