Skip to main content
Glama

x_api_get_lists_by_id

Fetch a specific list from X API using its ID. Retrieve list details for a known list identifier to view its metadata.

Instructions

Get List by ID. Use when: Get List by ID. 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: bearer token; OAuth 2 user token with scopes list.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). 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_lists_by_id","arguments":{"scopeTenantId":"default","scopeUserId":"default","id":""}}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
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 the full burden and does so well: it states read-only risk, required OAuth/bearer permissions, environment-selection behavior for tenant principal resolution, and common failure conditions. It also warns that read-only responses can contain sensitive account data, adding meaningful safety context.

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 organized into labeled sections and front-loaded with the core purpose. It is longer than average but each section contributes; minor redundancy exists in repeating 'Get List by ID' and read-only risk.

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 lacking an output schema, the description defines the expected response shape and covers permissions, failure modes, and an example invocation. This is a high level of contextual completeness for a wrapper around a single GET endpoint.

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 must compensate. It explains id as a required path parameter and clarifies the roles of scopeTenantId, scopeUserId, scopeAccountId, and credentialKey in environment/auth selection. However, authorizationKey and preferredAuthType are not explained, leaving some parameters to rely on their names/enum.

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 opening sentence 'Get List by ID' uses a specific verb and resource, and the name further disambiguates from sibling list-related endpoints (followers, members, posts). It clearly identifies this as a single-resource GET.

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

Usage Guidelines5/5

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

The description explicitly provides a 'Use when' condition, a 'Do not use when' exclusion for exploration scenarios, and names alternatives (x_schema_discovery, x_query_suggestion). It also lists recommended prerequisite and follow-up tools, giving an agent clear decision context.

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