Skip to main content
Glama

x_api_get_direct_messages_events_by_conversation_id

Retrieve direct message events for a conversation by ID. Use pagination and event type filters to target specific DM history.

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: 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_conversation_id","arguments":{"scopeTenantId":"default","scopeUserId":"default","id":""}}

Input Schema

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

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

With no annotations available, the description carries the full burden and does so thoroughly. It clearly states 'Risk: read-only', lists required OAuth scopes, explains environment-selection behavior for auth resolution, details common failure conditions (missing credentials, rate limits, etc.), and warns about sensitive data exposure. This exceeds typical transparency.

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, making it easy to scan. It is front-loaded with purpose and risk. Some redundancy exists ('Use when' repeats the purpose), but overall each section adds meaningful information without excessive fluff.

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

Completeness5/5

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

This is a complex tool with 10 parameters, no output schema, and no annotations. The description provides a comprehensive picture: expected response shape, common failure conditions, recommended prerequisites, environment-selection behavior, safety warnings, and an example. It covers almost every aspect an agent needs to invoke the tool correctly.

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?

Given 0% schema coverage, the description partially compensates by listing key parameters (id, max_results, pagination_token, event_types) with types and location. It also explains scopeTenantId, scopeUserId, scopeAccountId, and credentialKey in prose. However, it omits authorizationKey and preferredAuthType, and does not fully explain the semantics of each parameter beyond basic type/location.

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 the tool's function: 'Get DM events for a DM conversation.' It names the resource and action. However, it does not explicitly distinguish itself from sibling tools like x_api_get_direct_messages_events_by_participant_id, relying on the tool name for the 'by_conversation_id' distinction.

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 purpose. The 'Do not use when' guidance is useful for directing exploration to x_schema_discovery or x_query_suggestion, but it does not address when to use this tool over alternative DM event retrieval tools. It does mention prerequisites and recommended companion tools, which adds some guidance.

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