Skip to main content
Glama
TweetAPI MCP

TweetAPI MCP

Official

Get TweetAPI Docs Page

tweetapi_docs_get_page
Read-onlyIdempotent

Fetch documentation for a TweetAPI endpoint by exact path or keyword, including method, path, parameters, cost, and an example request. Resolve endpoints before integration without API keys or units.

Instructions

Return the full reference for one TweetAPI endpoint: its method, path, title and whole docs section, with parameters, cost and an example request. An exact path such as /tw-v2/user/followers returns that endpoint; a keyword returns the single best match, and no match returns a TWEETAPI_DOCS_PAGE_NOT_FOUND error. Free: uses no API key or units.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "pathOrKeyword": "<pathOrKeyword>"
    },
    "name": "tweetapi_docs_get_page"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathOrKeywordYesAn endpoint path such as /tw-v2/user/followers, or a keyword such as followers. A path gives the most precise match.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.3.3
    • addedInput schema / properties / pathOrKeyword / description
      Added value: +"An endpoint path such as /tw-v2/user/followers, or a keyword such as followers. A path gives the most precise match."
  2. First observedv0.2.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, openWorld and non-destructive, so the safety profile is covered. The description goes beyond them usefully by disclosing the failure mode (TWEETAPI_DOCS_PAGE_NOT_FOUND) and the cost/auth profile ('Free: uses no API key or units'), which an agent needs for planning. It does not describe payload size or pagination of the returned docs section, keeping it short of a 5.

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?

Two tight sentences with zero filler: the return payload is front-loaded, followed by the path/keyword/error contract and the cost note. Every clause carries information an agent would otherwise have to guess.

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 a single required parameter, full schema coverage, no output schema and complete annotation coverage, the description supplies precisely what is missing: return shape, match precedence, error behavior and cost. Nothing an agent needs to invoke this correctly is absent.

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 100% and the parameter description already states that a path yields the most precise match, so the description's restatement of path-vs-keyword behavior adds little new meaning. Baseline 3 applies when the schema carries parameter semantics.

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 uses a specific verb and resource ('Return the full reference for one TweetAPI endpoint') and enumerates exactly what comes back: method, path, title, whole docs section, parameters, cost and example request. It implicitly distinguishes itself from docs_search by promising a single endpoint rather than a result list, but it never names that sibling explicitly, so routing still takes a small inference.

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?

Clear operating guidance: an exact path like /tw-v2/user/followers returns that endpoint, a keyword returns the single best match, and a miss returns TWEETAPI_DOCS_PAGE_NOT_FOUND. What is missing is an explicit alternative — the description never points to tweetapi_docs_search or tweetapi_endpoint_lookup for cases where the agent wants multiple matches or a lookup rather than full docs.

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