Skip to main content
Glama

user_list

List all users in Crafty Controller with details like username, permissions, and creation date. Use the ids_only parameter to retrieve just user IDs.

Instructions

List all Crafty Controller users. Returns user_id, username, enabled, superuser, lang, and creation date.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
ids_onlyNoIf true, returns only user IDs for a minimal response

Implementation Reference

  • The handler function for the 'user_list' tool.
    async ({ ids_only }) => {
      try {
        const path = ids_only ? "/users?ids=true" : "/users";
        const data = await client.get(path);
        return { content: [{ type: "text", text: JSON.stringify(data, null, 2) }] };
      } catch (error) {
        const msg = error instanceof Error ? error.message : String(error);
        return { content: [{ type: "text", text: `Error: ${msg}` }], isError: true };
      }
    }
  • Registration of the 'user_list' tool with its schema and handler.
    server.tool(
      "user_list",
      "List all Crafty Controller users. Returns user_id, username, enabled, superuser, lang, and creation date.",
      {
        ids_only: z
          .boolean()
          .optional()
          .describe("If true, returns only user IDs for a minimal response"),
      },
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. It mentions the return fields (user_id, username, etc.), which is helpful, but lacks critical behavioral details such as whether this requires authentication, if there are rate limits, pagination behavior, or error conditions. For a tool with no annotations, this is insufficient.

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 front-loads the core action ('List all Crafty Controller users') and adds necessary detail about return values. There is no wasted verbiage or redundancy, making it highly concise and well-structured.

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

Completeness3/5

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

Given the tool's low complexity (1 parameter, no output schema, no annotations), the description is minimally adequate. It covers the purpose and return fields, but lacks behavioral context (e.g., auth needs, pagination) and usage guidelines. For a simple read operation, it meets basic needs but leaves gaps.

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 the schema already fully documents the single parameter (ids_only). The description does not add any additional meaning or context about parameters beyond what the schema provides, such as default behavior or implications of using ids_only. Baseline 3 is appropriate when 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 ('List') and resource ('Crafty Controller users'), making the purpose specific and understandable. It distinguishes from siblings like user_get (which retrieves a single user) and user_create (which creates users). However, it doesn't explicitly differentiate from user_list_api_keys or other list operations, keeping it at a 4 rather than a 5.

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. For example, it doesn't mention when to use user_list versus user_get (for a single user) or user_get_api_keys (for API keys). The description only states what it does, not when it's appropriate.

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/HadiCherkaoui/crafty-mcp'

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