Skip to main content
Glama
victorbenazzi

Ploomes MCP Server

by victorbenazzi
OverviewSchemaRelated ServersScoreDiscussions
TypeScript
Hybrid

List Contacts

ploomes_contacts_list
Read-onlyIdempotent

Search and list contacts in Ploomes CRM using OData filters for exact match, text search, or date ranges. Supports pagination, field selection, and related entity expansion.

Instructions

Search and list contacts in Ploomes CRM. Supports OData filtering, sorting, field selection, and pagination.

Available $expand values: Type, Company, Tags, OtherProperties, InteractionRecords, Attachments, Documents, Products, Contacts.

$filter examples:

  • Exact match: "Name eq 'João Silva'"

  • Contains text: "contains(Name, 'Silva')"

  • Starts with: "startswith(Email, 'joao')"

  • By status: "StatusId eq 1"

  • By type: "TypeId eq 2"

  • Date filter: "CreateDate ge 2025-01-01T00:00:00Z"

  • Custom field: "OtherProperties/any(o: o/FieldId eq 12345 and o/StringValue eq 'valor')"

  • Combined: "TypeId eq 1 and contains(Name, 'Silva') and StatusId eq 1"

Use ploomes_contacts_types_list to discover valid TypeId values. Use ploomes_contacts_status_list to discover valid StatusId values. Use ploomes_contacts_origins_list to discover valid OriginId values.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
filterNoOData $filter expression. Examples: "Name eq 'João'", "contains(Name, 'Silva')", "StatusId eq 1", "TypeId eq 2 and contains(Email, '@empresa.com')", "CreateDate ge 2025-01-01T00:00:00Z", "OtherProperties/any(o: o/FieldId eq 12345 and o/StringValue eq 'valor')"
selectNoComma-separated fields to return. E.g.: "Id,Name,Email,TypeId,StatusId,OwnerId". NOTE: Phone is NOT selectable — omit it from $select and use $expand=Phones instead.
expandNoRelated entities to include. Available: Type, Company, Tags, OtherProperties, InteractionRecords, Attachments, Documents, Products, Contacts. E.g.: "OtherProperties,Tags,Company"
orderbyNoSort expression. E.g.: "Name asc", "CreateDate desc", "Revenue desc"
topNoMax items to return (default 50, max 300)
skipNoItems to skip for pagination. Use with $top to paginate through results.

Tool Definition Quality

A4.5/5.0
Behavior4/5

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

Annotations readOnlyHint=true, destructiveHint=false, idempotentHint=true already indicate safe read behavior. The description adds valuable details like pagination limits (max 300), expand options, and the caveat that Phone is not selectable, enhancing transparency beyond annotations.

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?

The description is well-structured with a front-loaded purpose, followed by expand values, filter examples, and sibling references. It could be slightly trimmed but is efficient for the complexity.

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 6 parameters, OData complexity, no output schema, and full annotations, the description covers filtering, sorting, pagination, expand, and links to sibling lookup tools. It is complete enough for an agent to use effectively.

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?

Schema coverage is 100%, but the description adds context: default top=50, max top=300, Phone not selectable, and provides OData filter examples for various scenarios, saving the agent from guessing syntax.

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 'Search and list contacts in Ploomes CRM' and lists specific capabilities (OData filtering, sorting, field selection, pagination). It distinguishes from sibling tools like ploomes_contacts_get (single contact) and ploomes_contacts_create/update/delete.

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

Usage Guidelines5/5

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

The description provides explicit usage context, including OData filtering, sorting, pagination, and serves as a query tool. It references sibling tools for lookups (e.g., ploomes_contacts_types_list for TypeId values), giving clear guidance on when to use this tool versus others.

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

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