Skip to main content
Glama

x_api_get_direct_messages_events_by_participant_id

Retrieve direct message events for a specific participant's DM conversation. Use this read-only X API tool to fetch DM event history, with options for pagination and event type filtering.

Instructions

Get DM events for a DM conversation. Use when: Get DM events for a DM conversation. 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 dm.read, 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: participant_id (path, unknown, required); max_results (query, integer); pagination_token (query, unknown); event_types (query, array). 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_get_direct_messages_events_by_participant_id","arguments":{"scopeTenantId":"default","scopeUserId":"default","participant_id":""}}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
event_typesNo
max_resultsNo
scopeUserIdNo
credentialKeyNo
scopeTenantIdNo
participant_idYes
scopeAccountIdNo
authorizationKeyNo
pagination_tokenNo
preferredAuthTypeNo
Behavior5/5

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

With no annotations, the description carries full burden and does so thoroughly: it declares read-only risk, lists required OAuth scopes, explains environment-selection behavior for scopeTenantId/scopeUserId/scopeAccountId, and notes common failure conditions and the possibility of sensitive data in responses.

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 well-structured with labeled sections and front-loaded with the main purpose. However, the 'Use when: Get DM events for a DM conversation' line is redundant with the first sentence, wasting space that could have been used for sibling differentiation.

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?

Despite lacking an output schema, the description provides the expected response shape, common failure conditions, prerequisites, and an example. It is missing details about pagination token usage and event_types allowed values, but for a complex tool with 10 parameters it is reasonably complete.

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

Parameters4/5

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

Schema description coverage is 0%, so the description compensates by providing parameter formats for participant_id, max_results, pagination_token, and event_types. It also explains the meaning of scopeTenantId, scopeUserId, scopeAccountId, and credentialKey in the environment-selection section, but leaves authorizationKey and preferredAuthType unexplained.

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 states 'Get DM events for a DM conversation' which clearly indicates the action and resource. However, it does not mention 'by participant ID' from the tool name, failing to distinguish it from sibling tools like x_api_get_direct_messages_events_by_conversation_id.

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 'Use when' section is tautological, merely repeating the description. The 'Do not use when' provides a general exploration alternative (x_schema_discovery, x_query_suggestion) but does not clarify when to choose this tool over other DM event retrieval siblings.

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