Skip to main content
Glama

x_api_dm_conversations_media_download

Download media attached to a direct message using the X API. Input DM, media, and resource IDs to retrieve the file with OAuth and dm.read scope.

Instructions

Download DM Media. Use when: Download DM Media. 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 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: dm_id (path, unknown, required); media_id (path, unknown, required); resource_id (path, unknown, required). 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_dm_conversations_media_download","arguments":{"scopeTenantId":"default","scopeUserId":"default","dm_id":""}}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dm_idYes
media_idYes
resource_idYes
scopeUserIdNo
credentialKeyNo
scopeTenantIdNo
scopeAccountIdNo
authorizationKeyNo
preferredAuthTypeNo
Behavior5/5

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

With no annotations provided, the description carries full behavioral disclosure and delivers: read-only risk, required OAuth scopes (dm.read), environment-selection behavior, expected response shape, common failure conditions, and safety warnings about sensitive data. This is comprehensive and exceeds the minimum needed to inform an agent.

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-organized with clearly labeled sections (Use when, Risk, Required permissions, etc.) and front-loads the core purpose. It is somewhat lengthy, and the first 'Use when' line redundantly restates the purpose, but each section provides actionable information and the structure aids quick scanning.

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 tool's complexity (9 params, no annotations, no output schema), the description covers most critical aspects: auth prerequisites, environment-selection behavior, response shape, failure conditions, recommended tools, and an example. However, it omits explanations for some optional parameters and does not elaborate on the meaning of the required resource IDs, so it's not fully complete.

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 coverage is 0%, so the description must compensate. It explains the behavior of scopeTenantId, scopeUserId, scopeAccountId, and credentialKey in environment selection, but the required path parameters (dm_id, media_id, resource_id) are only listed as 'path, unknown, required' with no semantic meaning. Optional params like authorizationKey and preferredAuthType are left undocumented, leaving notable gaps.

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 opens with 'Download DM Media,' a specific verb+resource that clearly states the tool's function. The tool name itself differentiates it from chat media download and other media tools, but the description doesn't explicitly contrast with siblings like x_api_chat_media_download, so it's clear but not fully differentiated.

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

Usage Guidelines4/5

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

The description includes explicit 'Use when' and 'Do not use when' sections, advising against using it for exploration and recommending x_schema_discovery or x_query_suggestion instead. It also lists recommended prerequisite and follow-up tools (x_connection_info, x_auth_get_scope_credentials, x_api_request), providing solid context for when this tool fits in a workflow.

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