Skip to main content
Glama

Sellsy MCP by usefulapi

Search opportunities

sellsy_search_opportunities
Read-onlyIdempotent

Search opportunities by name, number, pipeline, step, status (open/won/lost/cancelled/closed/late), amount, owner or due date. Needs opportunities.read.

Input Schema

NameRequiredDescriptionDefault
embedNoRelated objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
fieldNoOnly return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
limitNoRecords per page, 1-100 (default 25).
orderNoSort field: id, created, step_rank, due_date, amount.
offsetNoPaging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
filtersNoSearch filters as an object. Unknown keys are refused by Sellsy. Keys: name, number, pipeline [pipeline ids], step [step ids], statuses ["open"|"won"|"lost"|"cancelled"|"closed"|"late"], amount {min,max}, owners [staff ids], assigned_staffs [staff ids], related_objects [{type:"company"|"individual",id}], created {start,end} ISO date-times, due_date {start,end} ISO date-times.
directionNoSort direction (default asc).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, so the safety profile is fully covered. The description contributes the scope requirement (opportunities.read), which is valuable, but says nothing about result size, paging behavior, or matching semantics.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short clauses, front-loaded with the primary search capability, with the auth prerequisite trailing. Nothing is wasted, though the enumeration largely duplicates schema content.

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?

For a 7-parameter, zero-required, read-only search tool with fully documented schema and rich annotations, the description plus structured fields give an agent enough to invoke it correctly. Only the absence of paging/return-shape hints (no output schema exists) keeps this below 5.

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%, with limit/offset/order/direction/filters/embed/field all documented in detail, including cursor-vs-numeric paging. The description only re-lists filter dimensions already present in the filters schema, adding no syntax or format detail. Baseline 3 applies.

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?

States a specific verb (search) and resource (opportunities) and enumerates the searchable dimensions, which makes the retrieval semantics clear. It does not, however, distinguish itself from close siblings like sellsy_list_opportunities or the generic sellsy_search, so an agent must infer the boundary.

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

Usage Guidelines3/5

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

"Needs opportunities.read" gives a real prerequisite, and the enumerated filter fields imply this is the tool for filtered/query retrieval. But there is no explicit when-to-use vs. list_opportunities or generic search, and no statement about how multiple filters combine.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.