Skip to main content
Glama

get_payment_types

Retrieve all configured payment methods like cash, credit card, and bank transfer to use their IDs when creating invoices or cash receipts in Siigo.

Instructions

Get all configured payment types/methods.

Returns a list of payment types (cash, credit card, bank transfer, etc.) Use these payment type IDs when creating invoices or cash receipts.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The main handler function for the 'get_payment_types' tool, decorated with @mcp.tool. It retrieves payment types from the Siigo API.
    @mcp.tool
    async def get_payment_types(ctx: Context) -> list[dict[str, Any]]:
        """Get all configured payment types/methods.
    
        Returns a list of payment types (cash, credit card, bank transfer, etc.)
        Use these payment type IDs when creating invoices or cash receipts.
        """
        return await get_client(ctx).get("/payment-types")
  • Import of the reference module in server.py, which triggers registration of the @mcp.tool functions including get_payment_types.
    from siigo_mcp.tools import reference  # noqa: E402, F401
  • Dynamic registration mapping in lazy loading mode, linking tool name to the handler function.
    "get_payment_types": reference.get_payment_types,
  • Tool index entry used for discovery, providing name, category, and summary for get_tool_schema.
    {"name": "get_payment_types", "category": "reference", "summary": "Get all payment types/methods"},
Behavior3/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 describes the return format ('list of payment types') and hints at a read-only operation ('Get'), but lacks details on permissions, rate limits, or error handling. This is adequate for a simple read tool but misses deeper behavioral traits.

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 appropriately sized and front-loaded, with two concise sentences that directly state the tool's purpose and usage without any wasted words. Each sentence adds clear value, making it efficient and well-structured.

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?

Given the tool's simplicity (0 parameters, no annotations, but with an output schema), the description is mostly complete. It explains what the tool does and how to use the results, but could benefit from mentioning the output schema's role or any limitations. The presence of an output schema reduces the need for return value details.

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 tool has 0 parameters with 100% schema description coverage, so no parameter information is needed. The description does not add parameter semantics, but this is acceptable as there are no parameters to document, warranting a baseline score above the minimum.

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 the tool's purpose with a specific verb ('Get') and resource ('all configured payment types/methods'), and distinguishes it from siblings by focusing on payment types rather than other entities like customers, invoices, or products. It explicitly mentions what the tool returns, making its function unambiguous.

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 clear context on when to use this tool: to retrieve payment types for use in creating invoices or cash receipts. It implies usage by linking to other operations, but does not explicitly state when not to use it or name specific alternatives among siblings, which keeps it from a perfect score.

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