Skip to main content
Glama

zulip_get_users

Retrieve a list of users in your Zulip organization to manage team members and facilitate communication within the workspace.

Instructions

Get list of users in the Zulip organization

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Handler case for 'zulip_get_users' tool: calls ZulipClient.getUsers() and serializes the response as JSON text content.
    case "zulip_get_users": {
      const response = await zulipClient.getUsers();
      return {
        content: [{ type: "text", text: JSON.stringify(response) }],
      };
    }
  • ZulipClient helper method implementing the core logic to retrieve all users via the Zulip JS client API.
    async getUsers() {
      try {
        return await this.client.users.retrieve();
      } catch (error) {
        console.error("Error getting users:", error);
        throw error;
      }
    }
  • Tool schema: defines name, description, and empty input schema (no parameters required).
    const getUsersTool: Tool = {
      name: "zulip_get_users",
      description: "Get list of users in the Zulip organization",
      inputSchema: {
        type: "object",
        properties: {},
      },
    };
  • index.ts:546-546 (registration)
    Registration of the tool in the ListTools response array.
    getUsersTool,
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 the tool retrieves a user list but doesn't mention any behavioral traits such as pagination, rate limits, authentication needs, or what data is included in the list, leaving significant gaps for a read 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 a single, efficient sentence that directly states the tool's purpose without any wasted words. It is appropriately sized and front-loaded, making it easy to understand 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 lack of annotations and output schema, the description is incomplete. It doesn't address behavioral aspects like return format, pagination, or error handling, which are crucial for a list-retrieval tool, 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.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 0 parameters with 100% coverage, so no parameter documentation is needed. The description appropriately avoids redundant parameter details, aligning with the baseline for zero parameters, though it doesn't add extra semantic value beyond the schema.

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 action ('Get list') and resource ('users in the Zulip organization'), providing a specific verb+resource combination. However, it doesn't explicitly differentiate from sibling tools like 'zulip_list_channels' or 'zulip_get_topics' that also retrieve lists, missing full sibling distinction.

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. The description lacks context about use cases, prerequisites, or comparisons to siblings like 'zulip_get_channel_history' for user-related data, offering no explicit or implied usage instructions.

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/Monadical-SAS/zulip-mcp'

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