Skip to main content
Glama

getSystemInfo

Retrieve system information from Directus by querying endpoints such as health, info, or activity. Use authentication tokens and API URLs to access data seamlessly.

Instructions

Get system information from Directus

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
endpointYesSystem endpoint (e.g. 'health', 'info', 'activity')
tokenNoAuthentication token (default from config)
urlNoDirectus API URL (default from config)

Implementation Reference

  • Handler implementation for the getSystemInfo tool. It fetches data from Directus /server/{endpoint} endpoint using axios GET request with authentication token and returns the JSON response.
    case "getSystemInfo": {
      const token = toolArgs.token || CONFIG.DIRECTUS_ACCESS_TOKEN;
      const endpoint = toolArgs.endpoint as string;
      
      const response = await axios.get(
        `${url}/server/${endpoint}`,
        { headers: buildHeaders(token) }
      );
      
      return {
        content: [
          {
            type: "text",
            text: JSON.stringify(response.data, null, 2)
          }
        ]
      };
    }
  • index.ts:226-247 (registration)
    Tool registration in the ListTools response, defining name, description, and input schema for getSystemInfo.
    {
      name: "getSystemInfo",
      description: "Get system information 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)"
          },
          endpoint: { 
            type: "string", 
            description: "System endpoint (e.g. 'health', 'info', 'activity')"
          }
        },
        required: ["endpoint"]
      }
    },
  • Input schema definition for the getSystemInfo tool, specifying parameters like url, token, and required endpoint.
    inputSchema: {
      type: "object",
      properties: {
        url: { 
          type: "string", 
          description: "Directus API URL (default from config)"
        },
        token: { 
          type: "string", 
          description: "Authentication token (default from config)"
        },
        endpoint: { 
          type: "string", 
          description: "System endpoint (e.g. 'health', 'info', 'activity')"
        }
      },
      required: ["endpoint"]
    }
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 it 'Get system information' but doesn't clarify if this is a read-only operation, requires authentication, has rate limits, or what the output format is. For a tool with no annotations, this leaves significant gaps in understanding its behavior.

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's front-loaded and appropriately sized for a simple retrieval tool, making it easy to parse quickly.

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 system information with multiple endpoints, no annotations, and no output schema, the description is incomplete. It doesn't explain what 'system information' entails, how endpoints differ, or what the return values look like, leaving the agent with insufficient context for effective use.

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 clear explanations for each parameter (e.g., 'endpoint' as system endpoint like 'health', 'info', 'activity'). The description adds no additional parameter semantics beyond what the schema provides, so it meets the baseline for high schema coverage without compensating further.

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 'system information from Directus', making the purpose evident. However, it doesn't differentiate from sibling tools like 'getConfig' or 'getActivity', which also retrieve system-related data, so it's not fully specific about what distinguishes this tool.

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?

No guidance is provided on when to use this tool versus alternatives. With siblings like 'getConfig' and 'getActivity' that might overlap in retrieving system information, the description lacks context on usage scenarios, exclusions, or prerequisites, leaving the agent to infer based on parameter names alone.

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