Skip to main content
Glama

x_api_mark_chat_conversation_read

Mark a chat conversation as read on X to clear its unread status for the authenticated user. Resolves unread message notifications by updating the conversation state.

Instructions

Mark Conversation as Read. Use when: Mark Conversation as Read. 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: mutating, high-risk. Required permissions and prerequisites: OAuth 2 user token with scopes dm.write, 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); body is used for the documented request payload. 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_upsert_principal_credentials, x_api_request. Safety warnings: This mutates X state. Validate scope, payload, and authorizationKey before use. Example: {"name":"x_api_mark_chat_conversation_read","arguments":{"scopeTenantId":"default","scopeUserId":"default","id":"","body":{}}}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
bodyNo
scopeUserIdNo
credentialKeyNo
scopeTenantIdNo
scopeAccountIdNo
authorizationKeyNo
preferredAuthTypeNo
Behavior5/5

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

With no annotations, the description fully discloses risk (mutating, high-risk), required OAuth scopes, environment-selection behavior, expected response shape, common failure conditions, and safety warnings. It provides comprehensive behavioral context well beyond minimal requirements.

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 labeled sections, making it easy to scan. Some redundancy exists ('Mark Conversation as Read' appears both as title and in 'Use when'), but each section adds meaningful detail, and length is justified by the tool's complexity.

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?

Despite no output schema, the description provides expected response shape, examples, prerequisites, failure modes, and recommended companion tools. It covers all necessary context for an agent to safely and correctly invoke this mutation, including environment-selection details.

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 coverage is 0%, but the description compensates by explaining id (path, required), body (request payload), and the scope/credential selection semantics for scopeTenantId, scopeUserId, scopeAccountId, and credentialKey. However, it leaves authorizationKey and preferredAuthType under-explained, though the schema enum provides some guidance for the latter.

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 the action 'Mark Conversation as Read' with a specific verb and resource. It distinguishes from sibling tools like x_api_get_chat_conversation or x_api_send_chat_message by targeting a distinct mutation. The purpose is immediately understandable.

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 provides explicit 'Use when' and 'Do not use when' guidance, mentioning alternatives like x_schema_discovery and x_query_suggestion for exploration, and auth/configuration tools before API calls. However, it does not explicitly contrast with other chat conversation tools, leaving some ambiguity for selecting this action over similar mutations.

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