Skip to main content
Glama

getUsers

Retrieve user data from Directus CMS by providing API URL, authentication token, and optional query parameters for filtering or sorting results.

Instructions

Get users 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 for the getUsers tool: performs a GET request to /users endpoint with token and optional query params, returns JSON response.
    case "getUsers": {
      const token = toolArgs.token || CONFIG.DIRECTUS_ACCESS_TOKEN;
      const query = toolArgs.query as Record<string, any> | undefined;
      
      const response = await axios.get(
        `${url}/users`,
        { 
          headers: buildHeaders(token),
          params: query
        }
      );
      
      return {
        content: [
          {
            type: "text",
            text: JSON.stringify(response.data, null, 2)
          }
        ]
      };
    }
  • index.ts:418-439 (registration)
    Tool registration in listTools handler: defines name, description, and input schema for getUsers.
    {
      name: "getUsers",
      description: "Get users 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: []
      }
    },
  • Input schema definition for the getUsers tool.
    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 the full burden of behavioral disclosure. It states 'Get users' but doesn't clarify if this is a read-only operation, what permissions are required, whether it supports pagination or filtering beyond the 'query' parameter, or what the output format is. This leaves significant gaps for an AI agent to understand how to invoke it effectively.

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 with a single sentence ('Get users from Directus'), which is front-loaded and wastes no words. It efficiently communicates the core purpose without unnecessary elaboration, earning the highest score for brevity and clarity.

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 complexity of retrieving users from a system like Directus, with no annotations and no output schema, the description is incomplete. It doesn't explain what data is returned, how to handle authentication (though hinted in schema), or differentiate from sibling tools. This makes it inadequate for an AI agent to use the tool confidently without additional context.

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, clearly documenting all three parameters (query, token, url) with their types and optional status. The description adds no additional parameter semantics beyond what's in the schema, so it meets the baseline score of 3 for high schema coverage without extra value.

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 ('users from Directus'), making the purpose immediately understandable. However, it doesn't differentiate this tool from similar sibling tools like 'getCurrentUser' or 'getItems', which might also retrieve user-related data, so it doesn't reach the highest score.

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 like 'getCurrentUser' (for the logged-in user) or 'getItems' (which might retrieve users as items). There's no mention of prerequisites, such as authentication needs, or context for choosing this tool over siblings.

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