Skip to main content
Glama
TweetAPI MCP

TweetAPI MCP

Official

Get User Highlights

tweetapi_user_highlights
Read-onlyIdempotent

Fetches one page of posts a user added to their profile Highlights tab; paginate with the returned cursor. Use it to read X Premium highlights for a numeric user ID.

Instructions

Fetch one page of the posts a user has added to the Highlights tab of their profile. Highlights are an X Premium feature, so most accounts return an empty page. Read-only. Needs a TweetAPI API key and makes one TweetAPI request per call, usually costing 1 unit; each result includes a cost estimate. Returns one page: to get the next one, call again with cursor set to this result's completeness.nextCursor.

Input Schema

NameRequiredDescriptionDefault
cursorNocompleteness.nextCursor from the previous page. Omit it for the first page.
userIdYesNumeric user ID. This tool does not look up usernames; call tweetapi_user_by_username first if you only have a username or profile link.
responseFormatNofull (default) returns TweetAPI's JSON unchanged. compact keeps full post text, IDs, links, original dates, counts, and cursors but drops bulky fields; output.fieldsOmitted lists what was dropped.

Output Schema

NameRequiredDescriptionDefault
costYes
modeYes
toolYes
noticeYes
outputYes
resultYes
endpointYes
usageDocsNo
paginationNoPagination exactly as TweetAPI returned it.
statusCodeYes
retrievedAtYesWhen the MCP server received this response (ISO 8601). Not the post or profile date, and not a promise that X's data was fresh at that moment.
completenessYes
resolvedInputNoIdentifiers the MCP server parsed from links or @handles before calling TweetAPI.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.3.3
    • addedInput schema / properties / cursor / description
      Added value: +"completeness.nextCursor from the previous page. Omit it for the first page."
  2. Addedv0.2.1

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already declare readOnly/idempotent/non-destructive, and the description adds genuinely new operational facts: API key requirement, one TweetAPI request per call at roughly 1 unit, and a per-result cost estimate. It also flags the high-probability empty-result case, which prevents an agent from misreading an empty page as a failure.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with what is fetched, then the empty-page caveat, then auth/cost, then pagination. Every sentence contributes an actionable fact and none restates the tool title.

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?

With an output schema present, return values need not be described, and the description covers the remaining unknowns: cost model, credential requirement, pagination protocol, and the common empty-result outcome. Nothing an agent needs to invoke this correctly is missing.

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 100%, so the baseline is 3, and the description goes further by spelling out the cursor round-trip ('call again with cursor set to this result's completeness.nextCursor'). The responseFormat and userId semantics are left entirely to the schema, which is acceptable given its completeness.

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?

States a specific verb and resource with scope: 'Fetch one page of the posts a user has added to the Highlights tab of their profile.' This is clearly distinguishable from siblings like tweetapi_user_tweets or tweetapi_user_photos, and 'one page' sets the retrieval boundary up front.

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?

Gives strong context for expectations (Highlights is an X Premium feature, so most accounts return an empty page) and explains the continuation loop via completeness.nextCursor. It does not explicitly name a sibling to use instead when Highlights is empty — e.g., tweetapi_user_tweets — so the alternative routing is left implicit.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.