Skip to main content
Glama

twprojects-list_users

Read-only

Retrieve users from Teamwork projects, scoped by project ID or filtered by type (account, collaborator, or contact). Supports pagination and search.

Instructions

List users. Scope by project_id or filter by type (account/collaborator/contact).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number for pagination of results.
page_sizeNoNumber of results per page for pagination.
project_idNoThe ID of the project from which to retrieve users. Omit to list users across all projects.
search_termNoA search term to filter users by first or last names, or e-mail. The user will be selected if each word of the term matches the first or last name, or e-mail, not requiring that the word matches are in the same field.
typeNoType of user to filter by. The available options are account, collaborator or contact.
verboseNoIf false, returns id + name only — useful when scanning many results.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
metaNo
peopleNo
Behavior3/5

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

Annotations already indicate readOnlyHint=true, so the description adds value by mentioning scoping/filtering. However, it omits behavioral details like pagination, default behavior when project_id is omitted, and the effect of the verbose parameter, which are only in the schema.

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?

The description is two sentences, front-loaded with the verb, and contains no extraneous words. Every word earns its place.

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?

The description covers the core function and key filters, but it does not mention pagination, search_term, or verbose options. With 6 parameters and an output schema, a bit more detail would improve completeness.

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?

All 6 parameters have complete schema descriptions (100% coverage), so the description's mention of only project_id and type adds marginal value. It highlights key filters but does not enhance understanding beyond the schema.

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 'List users' and distinguishes this from other list tools by mentioning scoping via project_id and filtering by type. This differentiates it from siblings like twprojects-list_companies or twprojects-get_user.

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 description provides some context (scope by project_id, filter by type) but does not explicitly state when to use this tool over alternatives like twdesk-list_users or twprojects-get_user. No 'when not to use' guidance is given.

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/Teamwork/mcp'

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