Skip to main content
Glama

getFields

Retrieve field details for a specific collection in Directus via the Model Context Protocol, enabling streamlined interaction with CMS APIs for data management.

Instructions

Get fields for a collection

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
collectionYesCollection name
tokenNoAuthentication token (default from config)
urlNoDirectus API URL (default from config)

Implementation Reference

  • The handler function for the 'getFields' tool. It retrieves the fields schema for a given collection by making an authenticated GET request to the Directus API endpoint `/fields/{collection}` and returns the response as JSON text.
    case "getFields": {
      const token = toolArgs.token || CONFIG.DIRECTUS_ACCESS_TOKEN;
      const collection = toolArgs.collection as string;
      
      const response = await axios.get(
        `${url}/fields/${collection}`,
        { headers: buildHeaders(token) }
      );
      
      return {
        content: [
          {
            type: "text",
            text: JSON.stringify(response.data, null, 2)
          }
        ]
      };
    }
  • index.ts:310-331 (registration)
    Registration of the 'getFields' tool in the ListTools handler response. Includes the tool name, description, and input schema defining required 'collection' parameter and optional 'url' and 'token'.
    {
      name: "getFields",
      description: "Get fields for a collection",
      inputSchema: {
        type: "object",
        properties: {
          url: { 
            type: "string", 
            description: "Directus API URL (default from config)"
          },
          token: { 
            type: "string", 
            description: "Authentication token (default from config)"
          },
          collection: {
            type: "string",
            description: "Collection name"
          }
        },
        required: ["collection"]
      }
    },
  • The input schema for the 'getFields' tool, specifying an object with optional 'url' and 'token' properties, and required 'collection' string.
    inputSchema: {
      type: "object",
      properties: {
        url: { 
          type: "string", 
          description: "Directus API URL (default from config)"
        },
        token: { 
          type: "string", 
          description: "Authentication token (default from config)"
        },
        collection: {
          type: "string",
          description: "Collection name"
        }
      },
      required: ["collection"]
    }
Behavior2/5

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

No annotations are provided, so the description carries full burden for behavioral disclosure. While 'Get' implies a read operation, the description doesn't address authentication requirements (despite a token parameter), rate limits, pagination, error conditions, or what 'fields' actually means in this context. It provides minimal behavioral context beyond the basic operation.

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 extremely concise - a single 5-word sentence that gets straight to the point. There's zero wasted language or unnecessary elaboration. While it may be too brief for complete understanding, it's perfectly efficient in terms of word economy.

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?

For a tool with 3 parameters, no annotations, and no output schema, the description is insufficiently complete. It doesn't explain what 'fields' means in this context, what format the response takes, or how this differs from similar data retrieval tools. The combination of sparse description and missing structured metadata creates significant gaps for an agent trying to use this tool effectively.

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 100%, so all parameters are documented in the schema. The description adds no additional parameter information beyond what's already in the structured schema. It doesn't explain relationships between parameters or provide usage examples. Baseline 3 is appropriate when the schema does the heavy lifting.

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 ('fields for a collection'), making the purpose understandable. However, it doesn't distinguish this tool from similar siblings like 'getCollections' or 'getItems' - it's unclear if this retrieves metadata about fields versus actual field data. The description is specific but lacks 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. With siblings like 'getCollections', 'getItems', and 'getRelations', there's no indication whether this tool is for metadata retrieval, schema inspection, or something else. No prerequisites, exclusions, or comparison to similar tools are mentioned.

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

Related 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/pixelsock/directus-mcp'

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