Obriym CRM

Search deals

search_deals

Read-only

List and search pipeline deals, filtered by stage/owner/company/contact/stale and paginated. Returns summary rows (id, title, stage, amount, probability, owner, company, contact, next-action, isStale) plus pagination { page, perPage, total }. Use get_deal to fetch one deal's full detail by id.

Input Schema

Name	Required	Description
`q`	No	Free-text search over the deal title. Omit for no text filter.
`page`	No	1-based page number of results to return. Default 1.
`stale`	No	Set "true" to return only stale deals (past their next-action date or long untouched).
`ownerId`	No	Filter to deals owned by this workspace member's user id.
`perPage`	No	Number of deals per page (1-100). Default 25.
`stageId`	No	Filter to deals in this pipeline stage id (from list_pipeline_stages).
`companyId`	No	Filter to deals linked to this company id (from search_companies).
`contactId`	No	Filter to deals linked to this contact id (from search_contacts).

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedJul 29, 2026

changedInput schema / $schema

Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"

Changed2 schema fields changedJul 16, 2026

addedInput schema / properties / page

Added value: +{
+  "default": 1,
+  "description": "1-based page number of results to return. Default 1.",
+  "exclusiveMinimum": 0,
+  "maximum": 9007199254740991,
+  "type": "integer"
+}

addedInput schema / properties / perPage

Added value: +{
+  "default": 25,
+  "description": "Number of deals per page (1-100). Default 25.",
+  "maximum": 100,
+  "minimum": 1,
+  "type": "integer"
+}

Changed6 schema fields changedJul 12, 2026

addedInput schema / properties / companyId / description

Added value: +"Filter to deals linked to this company id (from search_companies)."

addedInput schema / properties / contactId / description

Added value: +"Filter to deals linked to this contact id (from search_contacts)."

addedInput schema / properties / ownerId / description

Added value: +"Filter to deals owned by this workspace member's user id."

addedInput schema / properties / q / description

Added value: +"Free-text search over the deal title. Omit for no text filter."

addedInput schema / properties / stageId / description

Added value: +"Filter to deals in this pipeline stage id (from list_pipeline_stages)."

addedInput schema / properties / stale / description

Added value: +"Set \"true\" to return only stale deals (past their next-action date or long untouched)."

First observedJul 9, 2026

TDQS

A4.7/5.0

Behavior5/5

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

Beyond the readOnlyHint and destructiveHint annotations, the description discloses the exact return format: 'summary rows (id, title, stage, amount, probability, owner, company, contact, next-action, isStale) plus pagination { page, perPage, total }.' This adds meaningful behavioral context about what results look like and pagination, which annotations do not cover.

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?

Three sentences, each serving a distinct purpose: stating the action/filters, describing the return format, and pointing to the sibling tool for full detail. The description is front-loaded with the core purpose and contains no filler or redundant content.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema and 8 optional parameters, the description still covers the essentials: the tool's purpose, filter options, pagination behavior, return fields, and how to obtain full detail. This is sufficient for an agent to invoke the tool correctly without additional context.

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?

The input schema already provides full descriptions for all 8 parameters (100% coverage), so the description adds little extra meaning. It merely lists filter categories (stage/owner/company/contact/stale) without detailing syntax or whether filters combine with AND/OR, so a baseline score of 3 is appropriate.

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 opens with 'List and search pipeline deals' – a specific verb+resource combination – and enumerates the filter dimensions (stage/owner/company/contact/stale) and pagination. It also explicitly distinguishes from get_deal by noting 'Use get_deal to fetch one deal's full detail by id,' so an agent can clearly separate list/search from detail retrieval.

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 gives explicit guidance: use this tool for list/search with filters and pagination, and use get_deal for full detail. This provides a clear when-to-use vs. alternative, which is exactly what an agent needs to select between the two deal-focused tools.

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

All Obriym CRM tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?