Skip to main content
Glama

Search document users

search-document-users
Read-onlyIdempotent

Search the account's document users (individual people who have access to documents) by name or email.

Use this tool when:

  • You need a person's name to filter list-documents by document user

  • You want to find document users matching a search term

Searches first name, last name and email. A two-word query is matched as firstname + lastname. Results are capped and de-duplicated by name, so narrow the query if you don't find who you're looking for.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "query": "<query>"
    },
    "name": "search-document-users"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of document users to return (default and max: 25)
queryYesSearch term matched against document user first name, last name and email (case-insensitive, min 3 characters). A two-word query is matched as firstname + lastname

Output Schema

NameRequiredDescriptionDefault
document_usersNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so the safety profile is covered. The description adds behavior not in the annotations: results are capped and de-duplicated by name, and the search spans first name, last name and email. It does not mention output shape, but an output schema exists to carry that.

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?

Front-loaded opening sentence followed by a short scannable bullet list and a closing caveat. A little duplication between the first sentence and the bullets, but no sentence is wasted.

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 two-parameter search tool with rich annotations, full schema coverage and an output schema, the description covers the differentiator (document users vs other people types) and the cap/de-duplication behavior an agent needs to interpret sparse results. Only the lack of an explicit contrast with list-account-users and search-external-parties keeps it from 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% and both parameters are already documented there, including the two-word firstname+lastname rule and the 25-result cap. The description largely restates that same matching rule, adding no meaning beyond the schema; baseline 3 is appropriate.

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 and resource ("Search the account's document users") and immediately disambiguates the resource with the parenthetical "individual people who have access to documents", which separates it from account users and external parties in the sibling list. It does not explicitly name those siblings as alternatives, so it stops short of a full 5.

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?

A dedicated "Use this tool when" block gives two concrete triggers, one of which chains to a sibling (filter list-documents by document user), plus a fallback instruction to narrow the query when results are capped. There is no explicit when-not-to-use or a named alternative for people searches, so 4 rather than 5.

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.

Resources