Skip to main content
Glama
garoon
by garoon

Get Garoon Users

garoon-get-users

Retrieve user data from Garoon by searching name or code. Supports pagination and self-referential queries to get current user info.

Instructions

Get user data (name, ID, code) from Garoon by searching name/code. IMPORTANT: Omit name parameter for self-referential queries ('me', 'my', 'I', 'myself', 私, 僕, 自分) to return current user info. Supports pagination.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoA searchable display name or user code. IMPORTANT: Omit for self-referential queries ('me', 'my', 'I', 'myself', 私, 僕, 自分) to return current user info.
limitNoMaximum number of users to return (1-1000, default: 100)
offsetNoNumber of users to skip from the beginning (default: 0)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
errorNoError message. Present on error
resultNoResult of the operation. Present on success
statusNoHTTP status code from the Garoon API. Present only when the error is an HTTP error response
responseTextNoRaw response body from the Garoon API. Present only when the error is an HTTP error response
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are present, so the description must disclose behavior. It indicates a read operation ('Get user data') and pagination, but does not explicitly state idempotency, authentication requirements, or error handling. The self-referential behavior is a useful addition, but overall transparency is adequate rather than thorough.

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 two sentences with no fluff. The first sentence states the core purpose, and the second adds a critical usage caveat. Every word earns its place.

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

Completeness4/5

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

The description covers the main functionality, pagination, and a special case (self-referential). Output schema exists, so return values are covered. However, it does not clarify whether name search is exact or partial, or describe edge cases (e.g., no results). Still, it is fairly complete for a tool with simple parameters.

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 coverage is 100% with parameter descriptions, so baseline is 3. The description adds minimal extra meaning beyond repeating the self-referential instruction already in the schema's name description. The pagination note is redundant given limit/offset descriptions. Thus, no significant added value.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states 'Get user data (name, ID, code) from Garoon by searching name/code', which specifies verb, resource, and method. It distinguishes this tool from siblings like garoon-get-users-in-organization by focusing on searching by name/code rather than organization. The self-referential query note adds further specificity.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance for self-referential queries ('Omit name parameter...') and mentions pagination support. However, it does not explicitly state when to use this tool versus alternatives (e.g., garoon-get-users-in-organization), missing exclusionary guidance.

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/garoon/garoon-mcp-server'

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