GitHub v3 REST API

{
  "service_type": "platform",
  "base_url": "https://api.github.com",
  "auth_method": "oauth2",
  "auth_config": {
    "flows": ["authorization_code", "device_code", "personal_access_token", "github_app_installation_token"],
    "token_header": "Authorization: Bearer <token>",
    "notes": "GitHub supports OAuth 2.0 (web and device flows), fine-grained and classic personal access tokens, and GitHub App installation tokens. The provided URL is a support contact page, not the API base; the real API base is https://api.github.com."
  },
  "endpoints": [
    {
      "name": "REST API root",
      "method": "GET/ANY",
      "path": "/",
      "description": "Base for GitHub REST API v3 (documented as version 2022-11-28 for the modern REST API)."
    },
    {
      "name": "Repositories",
      "method": "GET/POST/PATCH/DELETE",
      "path": "/repos/{owner}/{repo}",
      "description": "Manage repositories, branches, contents, releases, and related resources."
    },
    {
      "name": "Issues",
      "method": "GET/POST/PATCH",
      "path": "/repos/{owner}/{repo}/issues",
      "description": "Create and manage issues, comments, labels, and milestones."
    },
    {
      "name": "Pull Requests",
      "method": "GET/POST/PATCH",
      "path": "/repos/{owner}/{repo}/pulls",
      "description": "Manage pull requests, reviews, and merge operations."
    },
    {
      "name": "Users",
      "method": "GET/PATCH",
      "path": "/users/{username}",
      "description": "Retrieve and manage user profile information."
    },
    {
      "name": "Organizations",
      "method": "GET/POST/PATCH",
      "path": "/orgs/{org}",
      "description": "Manage organizations, members, teams, and related settings."
    },
    {
      "name": "Actions",
      "method": "GET/POST",
      "path": "/repos/{owner}/{repo}/actions",
      "description": "Manage GitHub Actions workflows, runs, artifacts, and secrets."
    },
    {
      "name": "Search",
      "method": "GET",
      "path": "/search/{type}",
      "description": "Search repositories, code, issues, users, commits, and topics."
    },
    {
      "name": "GraphQL API",
      "method": "POST",
      "path": "https://api.github.com/graphql",
      "description": "Separate GraphQL v4 API for more flexible querying."
    }
  ],
  "pricing_model": {
    "type": "freemium",
    "details": {
      "free_tier": "GitHub Free supports public/private repos with limited features and standard API access.",
      "paid_tiers": "GitHub Pro, Team, Enterprise, and Enterprise Cloud provide additional features, higher limits, and advanced security/compliance.",
      "api_cost": "REST API usage itself is not billed separately; rate limits and feature access depend on plan and authentication."
    }
  },
  "rate_limits": {
    "unauthenticated": "60 requests per hour per IP",
    "authenticated_personal": "5,000 requests per hour per user",
    "oauth_app": "Up to 5,000 requests per hour per user, or 12,500 per hour for GitHub App installations on Enterprise Cloud",
    "search": "30 requests per minute for authenticated, 10 per minute unauthenticated",
    "secondary_limits": "GitHub also enforces secondary rate limits for concurrent requests and abusive behavior; responses include x-ratelimit-* headers and may return 403/429."
  },
  "capabilities": [
    "Full REST API v3 for repositories, users, organizations, issues, pull requests, releases, actions, packages, and more",
    "OAuth 2.0 and personal access token authentication",
    "GitHub Apps with fine-grained permissions and installation tokens",
    "GraphQL API v4 alongside REST",
    "Webhooks and event-driven integrations",
    "Pagination, conditional requests, and rate limit headers",
    "OpenAPI schema and extensive official documentation",
    "CLI (gh) and official SDKs/libraries for many languages"
  ],
  "raw_analysis": "The provided URL points to GitHub Support's contact page, which is an HTML sign-in/support landing page rather than API documentation. The service described is GitHub's v3 REST API, which is a mature, widely used, production-grade platform API. The actual API base URL is https://api.github.com, not support.github.com. Authentication supports OAuth 2.0, personal access tokens, and GitHub App installation tokens. The API covers a comprehensive set of resources (repos, issues, PRs, users, orgs, actions, search, etc.) and coexists with a GraphQL v4 API. Rate limits are well defined and documented, with higher limits for authenticated and enterprise users. Pricing for the platform is freemium: free for basic use, with paid plans adding features and higher limits. No API-specific per-call pricing. The HTML content provided is largely boilerplate and analytics; it does not contain endpoint details, so endpoints listed here are derived from GitHub's known public REST API."
}

1/3 tests passed

{
  "overall": 88,
  "dimensions": {
    "token_efficiency": 9.5,
    "first_try_success": 9.0,
    "response_parseability": 10.0,
    "error_clarity": 9.0,
    "doc_quality": 9.5,
    "auth_simplicity": 9.0,
    "latency": 10.0,
    "consistency": 9.5
  },
  "pricing_normalized": {
    "type": "freemium",
    "free_tier": "GitHub Free with standard API access",
    "paid_tiers": ["Pro", "Team", "Enterprise", "Enterprise Cloud"],
    "api_billing": "No separate API charges; rate limits and features depend on plan/auth",
    "notes": "Rate limits vary: unauthenticated 60/hr, authenticated 5000/hr, GitHub Apps have higher limits"
  },
  "issues": [
    "No robots.txt at api.github.com (404) — minor for API endpoints since robots.txt is intended for crawlers",
    "No llms.txt (404) — no machine-readable discovery hint for AI agents, though docs.github.com and openapi schemas exist",
    "Rate limiting complexity: different limits based on auth method (unauthenticated vs PAT vs App) can surprise new integrators",
    "Fine-grained permission model for GitHub Apps has a learning curve versus classic PATs",
    "Webhook delivery can be hard to debug without good tooling (secret verification, retries, redelivery)"
  ],
  "recommendations": [
    "Add /llms.txt at api.github.com or docs.github.com pointing agents to OpenAPI schema, GraphQL schema, and getting-started guides",
    "Surface REST and GraphQL schema endpoints and per-endpoint rate limit metadata in the first 200 response for easy agent discovery",
    "Provide a concise 'agent quickstart': 'create PAT or GitHub App → call GET /user → done' to maximize first-try success",
    "Document common error codes (401/403 rate limits, 422 validation, 404 scopes) in a single canonical table for error clarity",
    "Expose machine-readable endpoint metadata (e.g., Link headers already exist; also include rate-limit reset in ISO 8601 along with epoch)"
  ]
}