Skip to main content
Glama

get_twitterapi_guide

Retrieve full Twitter API documentation pages offline by specifying page keys like authentication or pricing for development reference.

Instructions

Get a TwitterAPI.io page from the offline snapshot by page key.

USE THIS WHEN: You need the full content of a specific page (guides, docs, policies, contact, etc.). TIP: Use search_twitterapi_docs if you don't know the page key.

RETURNS: Full guide content with headers, paragraphs, and code examples.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
guide_nameYesPage key (from data/pages). Examples: pricing, qps_limits, privacy, contact, introduction, authentication.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlNo
titleNo
headersNo
markdownYes
raw_textNo
guide_nameYes
list_itemsNo
paragraphsNo
descriptionNo
code_snippetsNo
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It discloses that the tool retrieves content from an 'offline snapshot' and specifies the return format ('Full guide content with headers, paragraphs, and code examples'), which adds useful behavioral context. However, it doesn't mention potential limitations like rate limits, error conditions, or authentication requirements, leaving some behavioral aspects unclear.

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?

The description is well-structured and concise, using bullet-like sections ('USE THIS WHEN:', 'TIP:', 'RETURNS:') to organize information efficiently. Each sentence adds clear value without redundancy, making it easy to scan and understand.

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 low complexity (1 parameter, 100% schema coverage, output schema exists), the description is mostly complete. It covers purpose, usage guidelines, and return format. However, with no annotations, it could benefit from more behavioral details (e.g., error handling). The existence of an output schema means the description doesn't need to explain return values in depth, but it still provides a helpful summary.

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?

The input schema has 100% description coverage, providing a clear description and enum values for the single parameter 'guide_name'. The description adds minimal value beyond the schema by mentioning 'page key' and listing examples like 'guides, docs, policies, contact', but doesn't provide additional syntax or format details. With high schema coverage, the baseline is 3, but the description slightly enhances understanding, warranting a 4.

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 clearly states the tool's purpose: 'Get a TwitterAPI.io page from the offline snapshot by page key.' It specifies the verb ('Get'), resource ('TwitterAPI.io page'), and source ('offline snapshot'), but doesn't explicitly differentiate it from sibling tools like get_twitterapi_auth or get_twitterapi_endpoint, which likely retrieve different types of content.

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 provides explicit usage guidance: 'USE THIS WHEN: You need the full content of a specific page (guides, docs, policies, contact, etc.).' It also names an alternative tool: 'TIP: Use search_twitterapi_docs if you don't know the page key.' This clearly indicates when to use this tool versus an alternative.

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/dorukardahan/twitterapi-io-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server