Skip to main content
Glama

Sellsy MCP by usefulapi

Search companies

sellsy_search_companies
Read-onlyIdempotent

Search companies by name, email, type (prospect/client/supplier), reference, VAT, SIRET, country, postal code, creation or update date. Needs companies.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: name, id, created_at, updated_at.
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 (exact), email (exact), type ("prospect"|"client"|"supplier" or an array), is_archived (bool), siret, vat, reference [..], id [ids], contacts [contact ids], country_code, postal_code [..], created {start,end} ISO date-times, updated_at {start,end} ISO date-times, number_of_employees {min,max}.
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, openWorldHint and destructiveHint=false, so the safety profile is covered. The description adds a concrete scope requirement ('companies.read'), which is real value beyond the annotations, but says nothing about result size, pagination, or empty-result behavior for a search across an open-world dataset.

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?

Two compact sentences, zero filler, with the searchable-field list front-loaded and the permission note trailing. Nothing here is redundant padding.

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?

For a 7-parameter tool with a nested filters object and no output schema, the description omits what a search returns and how paging/embed/field projection interact with results, leaving the schema to carry that load. The missing search-vs-list sibling routing is the most significant gap.

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%, so the parameter semantics are already fully documented, including the nested filters keys, embed, field, and the offset paging rules. The description restates a subset of the filter keys and adds the type enum values, which is marginal added value; 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) plus resource (companies) and enumerates the searchable attributes, so the agent knows exactly what can be queried. However, it never distinguishes itself from the sibling sellsy_list_companies, leaving the search-vs-list choice unresolved.

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?

The listed filter fields imply when to reach for this tool (attribute-based lookup), and 'Needs companies.read' signals a prerequisite scope. But there is no explicit statement about when to prefer it over sellsy_list_companies or sellsy_get_company, nor any exclusion guidance.

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.