List Workspace Members

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered. The description adds that each entry carries a workspace role and that filtering matches partial names/emails — useful context — but says nothing about pagination behavior or whether deactivated members are included, both of which matter for this tool.

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

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

One sentence, front-loaded with the verb and resource, with the optional filter clause deferred to the end. Nothing is wasted or repeated.

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

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

With an output schema present and full parameter documentation, the description needn't explain return values or pagination mechanics. The main remaining gap is the lack of disambiguation from list_space_members and list_group_members, which is a real risk given eight sibling membership tools.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, with limit, query, and cursor each documented (including next_cursor semantics), so the schema carries the parameter burden. The description only restates the query filter as a substring match, adding marginal clarification over the schema's 'Part of a name or email to filter by.'

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

Clear verb+resource: lists people in the Docmost workspace, states that workspace role is returned, and that filtering is optional and substring-based. It does not, however, distinguish itself from the nearby sibling list_space_members (per-space members) or list_group_members, which an agent could easily confuse it with.

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

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

Usage is implied by 'workspace' and the optional filter, so an agent can infer this is the workspace-wide roster rather than a space roster. But there is no explicit 'use this when...' statement and no exclusion naming list_space_members as the alternative for space-scoped membership.

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