Skip to main content
Glama

get_users

Retrieve all users from a Siigo account to assign them as sellers or responsible parties for electronic invoicing and business management.

Instructions

Get all users in the Siigo account.

Returns a list of users who can be assigned as sellers or responsible parties.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The handler function for the 'get_users' tool. It is decorated with @mcp.tool for automatic registration and fetches the list of users from the Siigo API endpoint '/users' using the get_client utility.
    @mcp.tool
    async def get_users(ctx: Context) -> list[dict[str, Any]]:
        """Get all users in the Siigo account.
    
        Returns a list of users who can be assigned as sellers or responsible parties.
        """
        return await get_client(ctx).get("/users")
  • Import statement in the main server file that loads the reference.py module, thereby registering the get_users tool (and other reference tools) via their @mcp.tool decorators when not operating in lazy tools mode.
    from siigo_mcp.tools import reference  # noqa: E402, F401
  • Registration of the get_users tool in the lazy-loading tool functions dictionary, mapping the tool name to the imported reference.get_users function.
    "get_users": reference.get_users,
  • Schema/discovery entry in TOOL_INDEX providing metadata (name, category, summary) for the get_users tool, used by list_siigo_tools.
    {"name": "get_users", "category": "reference", "summary": "Get all users in the account"},
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 the tool returns a list of users, which is basic output information, but lacks details on permissions required, rate limits, pagination, or error handling. For a read operation with zero annotation coverage, this is insufficient to inform safe and effective usage.

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 concise sentences that are front-loaded with the core purpose ('Get all users in the Siigo account') followed by additional context about the return value. Every sentence adds value without redundancy, making it efficient and well-structured for quick comprehension.

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 has 0 parameters, 100% schema coverage, and an output schema exists (which handles return values), the description's job is simplified. It covers the basic purpose and output type adequately. However, with no annotations and siblings that might contextually overlap (e.g., get_customer for user-related data), it lacks completeness in usage guidance and behavioral details, making it just minimally viable.

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 discussing parameters, focusing instead on the tool's purpose and output. This aligns with the baseline expectation for tools without parameters, earning a high score for not adding unnecessary information.

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 ('all users in the Siigo account'), making the purpose explicit. It distinguishes from siblings by focusing on users rather than other entities like invoices or products. However, it doesn't explicitly differentiate from potential user-related siblings (none exist in the provided list), so it falls short of a perfect 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?

The description provides no guidance on when to use this tool versus alternatives. It mentions users can be 'assigned as sellers or responsible parties,' which hints at use cases but doesn't specify scenarios, prerequisites, or exclusions. With siblings like get_customer or list_customers that might overlap in user contexts, the lack of explicit differentiation is a significant gap.

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/dsfaccini/siigo-mcp'

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