Skip to main content
Glama

x_api_search_users

Search X users by query, with optional max results and pagination, requiring authenticated OAuth credentials.

Instructions

Search Users. Use when: Search Users. Do not use when: a more specific auth/configuration tool is required before the API call or you are only exploring; prefer x_schema_discovery or x_query_suggestion first. Risk: read-only. Required permissions and prerequisites: OAuth 2 user token with scopes tweet.read, users.read; OAuth 1a user token Environment-selection behavior: scopeTenantId plus exactly one of scopeUserId or scopeAccountId choose the Vault/Postgres tenant principal used for auth resolution. credentialKey selects a non-default stored credential profile when present. Parameter formats and constraints: query (query, unknown, required); max_results (query, integer); next_token (query, unknown). Expected response shape: { ok, status, data: { method, path, url, status, contentType, authType, data } } Common failure conditions: missing scoped credentials in Vault, missing required API parameters, X API auth failures, rate limits, or unsupported multipart/body shape. Recommended prerequisite and follow-up tools: x_connection_info, x_schema_discovery, x_auth_get_scope_credentials, x_api_request. Safety warnings: This is read-only, but responses can still include sensitive account data depending on granted scopes. Example: {"name":"x_api_search_users","arguments":{"scopeTenantId":"default","scopeUserId":"default"}}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYes
next_tokenNo
max_resultsNo
scopeUserIdNo
credentialKeyNo
scopeTenantIdNo
scopeAccountIdNo
authorizationKeyNo
preferredAuthTypeNo
Behavior4/5

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

With no annotations, the description carries the full burden and does well: it declares read-only risk, required OAuth scopes/token types, environment-selection behavior for tenant/account scopes, expected response shape, common failure conditions, and safety warnings about sensitive data. It does not detail pagination behavior, but overall it is thorough.

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 long but well-structured into labeled sections. The 'Use when: Search Users' line is redundant and wastes space, yet the rest of the content is information-dense and organized, making it easy to scan.

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 the complexity (9 params, no annotations, no output schema), the description provides essential context: expected response shape, common failures, required permissions, environment selection, and a usage example. It lacks explicit pagination instructions but covers most operational needs.

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 0%, so the description must compensate. It does add meaning for scopeTenantId/scopeUserId/scopeAccountId and credentialKey by explaining their role in auth resolution. However, core parameters like query, max_results, and next_token are merely restated with types/constraints from the schema, with no semantic explanation of their meaning or usage.

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?

The description clearly states 'Search Users', which is a specific verb+resource pair. It lacks explicit differentiation from sibling tools like x_api_get_users_by_username, but the verb 'search' sufficiently distinguishes it from direct user lookups.

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 includes a 'Do not use when' clause with alternatives for exploration (x_schema_discovery, x_query_suggestion) and recommended prerequisite/follow-up tools. However, the 'Use when' condition is an unhelpful tautology ('Search Users'), providing no real guidance on when this tool should be chosen over similar search or user-related tools.

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/LesterAJohn/X-mcp'

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