Skip to main content
Glama

getRoles

Retrieve roles from Directus CMS via the Directus MCP Server using specified query parameters, authentication token, and API URL.

Instructions

Get roles from Directus

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryNoQuery parameters like filter, sort, limit, etc. (optional)
tokenNoAuthentication token (default from config)
urlNoDirectus API URL (default from config)

Implementation Reference

  • Handler implementation for the getRoles tool. Fetches roles from the Directus /roles endpoint using axios, with optional token and query parameters. Returns JSON stringified response data.
    case "getRoles": {
      const token = toolArgs.token || CONFIG.DIRECTUS_ACCESS_TOKEN;
      const query = toolArgs.query as Record<string, any> | undefined;
      
      const response = await axios.get(
        `${url}/roles`,
        { 
          headers: buildHeaders(token),
          params: query
        }
      );
      
      return {
        content: [
          {
            type: "text",
            text: JSON.stringify(response.data, null, 2)
          }
        ]
      };
    }
  • Input schema definition for the getRoles tool, specifying optional url, token, and query parameters.
    inputSchema: {
      type: "object",
      properties: {
        url: { 
          type: "string", 
          description: "Directus API URL (default from config)"
        },
        token: { 
          type: "string", 
          description: "Authentication token (default from config)"
        },
        query: {
          type: "object",
          description: "Query parameters like filter, sort, limit, etc. (optional)"
        }
      },
      required: []
    }
  • index.ts:458-479 (registration)
    Tool registration entry for getRoles in the tools array provided to the MCP server.
    {
      name: "getRoles",
      description: "Get roles from Directus",
      inputSchema: {
        type: "object",
        properties: {
          url: { 
            type: "string", 
            description: "Directus API URL (default from config)"
          },
          token: { 
            type: "string", 
            description: "Authentication token (default from config)"
          },
          query: {
            type: "object",
            description: "Query parameters like filter, sort, limit, etc. (optional)"
          }
        },
        required: []
      }
    },
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 but only states what the tool does, not how it behaves. It doesn't mention whether this is a read-only operation, what authentication is required, whether there are rate limits, what format the roles are returned in, or any other behavioral characteristics.

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 at just four words, front-loading the essential information with zero wasted words. Every element ('Get', 'roles', 'from Directus') earns its place by specifying the action, resource, and system context.

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 'roles' are in the Directus context, what data they contain, how results are structured, or provide any behavioral context that would help an agent understand the operation's implications and results.

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?

With 100% schema description coverage, the input schema already documents all three parameters thoroughly. The description adds no additional parameter information beyond what's in the schema, so it meets the baseline of 3 but doesn't provide extra value through examples, format details, or usage context.

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 ('roles from Directus'), making the purpose immediately understandable. However, it doesn't differentiate from sibling tools like 'getUsers', 'getCollections', or 'getPermissions' which follow the same pattern for different resources, missing the opportunity to clarify this is specifically for role data.

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 sibling tools like 'getUsers', 'getPermissions', and 'getCollections' that retrieve different types of data from the same system, there's no indication of when roles specifically are needed versus other entity types.

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