twitterapi-io-mcp

Instructions

Implementation Reference

• index.js:2205-2258 (handler)

  Handler implementation for get_twitterapi_pricing tool. Retrieves pricing and QPS limits from loaded docs data, constructs a detailed markdown response covering credits per USD, endpoint costs, minimum charge, QPS limits by tier, notes, and cost comparison. Returns formatted success response with structured content matching the output schema.

      case "get_twitterapi_pricing": {
        const pricing = data.pricing || {};
        const qps = data.qps_limits || {};
  
        const notes = [
          'Credits never expire',
          'Bonus credits valid for 30 days',
          'Up to 5% discount on bulk purchases',
          'List endpoints: 150 credits/request',
          '~97% cheaper than official Twitter API'
        ];
  
        const markdown = `# TwitterAPI.io Pricing
  
  ## Credit System
  - **1 USD = ${pricing.credits_per_usd?.toLocaleString() || "100,000"} Credits**
  
  ## Endpoint Costs
  ${Object.entries(pricing.costs || {}).map(([k, v]) => `- **${k}**: ${v}`).join("\n")}
  
  ## Minimum Charge
  ${pricing.minimum_charge || "15 credits ($0.00015) per request"}
  
  ## QPS (Queries Per Second) Limits
  
  ### Free Users
  ${qps.free || "1 request per 5 seconds"}
  
  ### By Balance Level
  ${Object.entries(qps.paid || {}).map(([k, v]) => `- **${k.replace(/_/g, " ")}**: ${v}`).join("\n")}
  
  ## Important Notes
  - Credits never expire
  - Bonus credits valid for 30 days
  - Up to 5% discount on bulk purchases
  - List endpoints: 150 credits/request
  
  ## Cost Comparison
  TwitterAPI.io is **~97% cheaper** than official Twitter API.
  - Twitter Pro: $5,000/month
  - TwitterAPI.io equivalent: ~$150/month`;
  
        return formatToolSuccess(markdown, {
          credits_per_usd: pricing.credits_per_usd || 100000,
          minimum_charge: pricing.minimum_charge || "15 credits ($0.00015) per request",
          costs: pricing.costs || {},
          qps_limits: {
            free: qps.free || "1 request per 5 seconds",
            paid: qps.paid || {}
          },
          notes,
          markdown
        });
      }

• index.js:1567-1626 (registration)

  Tool registration in ListToolsRequestSchema handler, including name, description, empty inputSchema (no parameters required), and detailed outputSchema defining the structured response fields for pricing data.

        name: "get_twitterapi_pricing",
        description: `Get TwitterAPI.io pricing information: credit system, endpoint costs, QPS limits.
  
  USE THIS WHEN: You need to know API costs, credit calculations, or rate limits.
  RETURNS: Pricing tiers, credit costs per endpoint, QPS limits by balance level.`,
        inputSchema: {
          type: "object",
          properties: {},
        },
        outputSchema: {
          type: "object",
          properties: {
            credits_per_usd: { type: "number" },
            minimum_charge: { type: "string" },
            costs: { type: "object", additionalProperties: { type: "string" } },
            qps_limits: {
              type: "object",
              properties: {
                free: { type: "string" },
                paid: { type: "object", additionalProperties: { type: "string" } }
              }
            },
            notes: { type: "array", items: { type: "string" } },
            markdown: { type: "string" }
          },
          required: ["markdown"]
        }
      },
      {
        name: "get_twitterapi_auth",
        description: `Get TwitterAPI.io authentication guide: API key usage, headers, code examples.
  
  USE THIS WHEN: You need to set up authentication or see request examples.
  RETURNS: API key header format, base URL, cURL/Python/JavaScript examples.`,
        inputSchema: {
          type: "object",
          properties: {},
        },
        outputSchema: {
          type: "object",
          properties: {
            header: { type: "string" },
            base_url: { type: "string" },
            dashboard_url: { type: "string" },
            examples: {
              type: "object",
              properties: {
                curl: { type: "string" },
                python: { type: "string" },
                javascript: { type: "string" }
              }
            },
            markdown: { type: "string" }
          },
          required: ["header", "base_url", "markdown"]
        }
      },
      ],
    };
  });

• index.js:1577-1594 (schema)

  Output schema definition for get_twitterapi_pricing tool, specifying the structure of the returned pricing data including credits_per_usd, minimum_charge, costs object, qps_limits nested object, notes array, and markdown string.

      type: "object",
      properties: {
        credits_per_usd: { type: "number" },
        minimum_charge: { type: "string" },
        costs: { type: "object", additionalProperties: { type: "string" } },
        qps_limits: {
          type: "object",
          properties: {
            free: { type: "string" },
            paid: { type: "object", additionalProperties: { type: "string" } }
          }
        },
        notes: { type: "array", items: { type: "string" } },
        markdown: { type: "string" }
      },
      required: ["markdown"]
    }
  },

• index.js:109-109 (helper)

  SLO (Service Level Objective) configuration for get_twitterapi_pricing tool in the logger metrics, defining performance targets: 5ms target, 20ms acceptable, 50ms alert threshold.

  get_twitterapi_pricing: { target: 5, acceptable: 20, alert: 50 },