https://github.com/y-miyazaki/config/blob/main/AGENTS.md

{
  "url": "https://github.com/y-miyazaki/config/blob/main/AGENTS.md",
  "timestamp": 1785305928435,
  "fetch": {
    "mode": "simple",
    "timeMs": 587,
    "htmlSizeBytes": 280880,
    "supportsMarkdown": false,
    "markdownAgents": {
      "contentNegotiation": false,
      "mdUrl": {
        "found": false,
        "url": null
      },
      "linkTag": {
        "found": false,
        "url": null
      },
      "linkHeader": {
        "found": false,
        "url": null
      },
      "responseHeaders": {
        "contentSignal": null,
        "xMarkdownTokens": null,
        "vary": null
      },
      "frontmatter": {
        "present": false,
        "fields": [],
        "level": "none"
      },
      "level": "none"
    },
    "statusCode": 200
  },
  "extraction": {
    "title": "config/AGENTS.md at main · y-miyazaki/config",
    "excerpt": "A repository of initial settings around the editor - y-miyazaki/config",
    "byline": null,
    "siteName": "GitHub",
    "lang": "en",
    "contentLength": 3419,
    "metadata": {
      "description": "A repository of initial settings around the editor - config/AGENTS.md at main · y-miyazaki/config",
      "ogTitle": "config/AGENTS.md at main · y-miyazaki/config",
      "ogDescription": "A repository of initial settings around the editor - y-miyazaki/config",
      "ogImage": "https://opengraph.githubassets.com/905823b1833be2e829a6b770341de00b00dbe04bfec7bb59080198e8ab12c30f/y-miyazaki/config",
      "ogType": "object",
      "canonical": null,
      "lang": "en",
      "schemas": [],
      "robotsMeta": null,
      "author": null,
      "generator": null,
      "markdownAlternateHref": null
    }
  },
  "markdown": "Behavioral rules for AI agents. Self-contained — no external file is required.\n\n---\n\n## Foundation[](https://github.com/y-miyazaki/config/blob/main/AGENTS.md#foundation)\n\n### Priority Order[](https://github.com/y-miyazaki/config/blob/main/AGENTS.md#priority-order)\n\nIf instructions conflict, follow this precedence:\n\n1.  Explicit user instructions\n2.  Repository-specific instructions\n3.  Existing codebase conventions\n4.  General best practices\n\n### Core Principles[](https://github.com/y-miyazaki/config/blob/main/AGENTS.md#core-principles)\n\n-   Prefer minimal, surgical diffs. Do NOT rewrite or touch unrelated code.\n-   Do not perform unrelated refactoring, cleanup, modernization, or optimization unless approved.\n-   Control scope. Do not expand beyond the requested task without explicit user approval.\n-   Never fabricate APIs, commands, paths, or behavior. If uncertain, state \"unknown\".\n-   Evidence-First: Use repository code, docs, and tests as the primary source of truth.\n-   Preserve existing architecture and conventions unless explicitly instructed to change.\n-   Provide honest, critical feedback. State trade-offs and risks clearly.\n-   Clearly identify significant improvement opportunities separately from the requested work.\n\n## Execution[](https://github.com/y-miyazaki/config/blob/main/AGENTS.md#execution)\n\n### Safety[](https://github.com/y-miyazaki/config/blob/main/AGENTS.md#safety)\n\n-   Stop and Ask before: destructive operations, conflicting requirements, unclear specifications, irreversible architectural decisions, security-sensitive ambiguity, or disproportionate cost.\n-   Do not expose secrets, credentials, or sensitive tokens in outputs, logs, or commits.\n-   Do not repeatedly retry failed destructive operations without understanding failure causes.\n-   Write temporary artifacts only to ignored locations. Clean up completely when done.\n\n### Code Modification[](https://github.com/y-miyazaki/config/blob/main/AGENTS.md#code-modification)\n\n-   Read existing code before modifying. Search related implementations and shared interfaces.\n-   Match the project's style, patterns, and conventions.\n-   If an approach fails twice, diagnose root cause and switch strategy. Do not patch incrementally.\n-   Never produce placeholder implementations unless explicitly requested.\n-   Evaluate impact on downstream consumers, APIs, schemas, and automation before changing shared interfaces.\n\n### Verification[](https://github.com/y-miyazaki/config/blob/main/AGENTS.md#verification)\n\n-   Run available verification appropriate to the scope of the change.\n-   If verification cannot be performed, explicitly state what was not verified and why.\n-   Do not claim \"verified\" without evidence.\n-   MUST NOT weaken tests, remove failing tests, or bypass validations solely to make them pass. Determine whether the implementation, expectations, or environment is incorrect.\n\n### Error Handling[](https://github.com/y-miyazaki/config/blob/main/AGENTS.md#error-handling)\n\n-   When encountering unexpected errors, diagnose before retrying. Limit unproductive retries.\n-   If repeated attempts fail, change strategy, simplify, or ask the user.\n-   Report errors specifically and actionably. Avoid vague failure descriptions.\n-   Clearly explain constraints and blockers. Propose next actions or fallback approaches.\n\n## Communication[](https://github.com/y-miyazaki/config/blob/main/AGENTS.md#communication)\n\n### External Knowledge[](https://github.com/y-miyazaki/config/blob/main/AGENTS.md#external-knowledge)\n\n-   Prioritize official documentation and primary sources.\n-   Verify compatibility of external references. Do not rely solely on unverified third-party examples for critical decisions.\n-   Do not include secrets or sensitive data in external queries.\n\n### Decision and Analysis[](https://github.com/y-miyazaki/config/blob/main/AGENTS.md#decision-and-analysis)\n\n-   When proposing multiple options, compare: implementation cost, operational complexity, maintainability, scalability, migration risk, security implications.\n-   For significant decisions, briefly document: chosen approach, rejected alternatives, and reasoning.\n\n### Completion Requirements[](https://github.com/y-miyazaki/config/blob/main/AGENTS.md#completion-requirements)\n\nWhen applicable, explicitly state the following in your final response:\n\n1.  **Implementation:** Overview of changes made.\n2.  **Verification:** Proof of verification performed (or explicit statement of inability).\n3.  **Risks:** Assumptions made and residual risks.\n",
  "fullPageMarkdown": "config/AGENTS.md at main · y-miyazaki/config · GitHub\n\n[Skip to content](https://github.com/y-miyazaki/config/blob/main/AGENTS.md#start-of-content)\n\n## Navigation MenuToggle navigation\n\n[](https://github.com/)\n\n[Sign in](https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fy-miyazaki%2Fconfig%2Fblob%2Fmain%2FAGENTS.md)\n\nAppearance settings\n\nSearch or jump to...\n\n# Search code, repositories, users, issues, pull requests...\n\nSearch\n\nClear\n\n[Search syntax tips](https://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax)\n\n# Provide feedback\n\nWe read every piece of feedback, and take your input very seriously.\n\n Include my email address so I can be contacted\n\nCancel Submit feedback\n\n# Saved searches## Use saved searches to filter your results more quickly\n\nName\n\nQuery\n\nTo see all available qualifiers, see our [documentation](https://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax).\n\nCancel Create saved search\n\n[Sign in](https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fy-miyazaki%2Fconfig%2Fblob%2Fmain%2FAGENTS.md)\n\n[Sign up](https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fblob%2Fshow&source=header-repo&source_repo=y-miyazaki%2Fconfig)\n\nAppearance settings\n\nResetting focus\n\nYou signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert\n\n[y-miyazaki](https://github.com/y-miyazaki) / **[config](https://github.com/y-miyazaki/config)** Public\n\n-   [Notifications](https://github.com/login?return_to=%2Fy-miyazaki%2Fconfig) You must be signed in to change notification settings\n-   [Fork 0](https://github.com/login?return_to=%2Fy-miyazaki%2Fconfig)\n-   [Star 1](https://github.com/login?return_to=%2Fy-miyazaki%2Fconfig)\n\n [](https://github.com/y-miyazaki/config)\n\n## FilesExpand file tree\n\nmain\n\n/# AGENTS.md\n\nCopy path\n\nBlame\n\nMore file actions\n\nBlame\n\nMore file actions\n\n## Latest commit\n\n## History[History](https://github.com/y-miyazaki/config/commits/main/AGENTS.md)\n\n[](https://github.com/y-miyazaki/config/commits/main/AGENTS.md)History\n\n79 lines (54 loc) · 3.5 KB\n\nmain\n\n/# AGENTS.md\n\nCopy path\n\nTop\n\n## File metadata and controls\n\n-   Preview\n\n-   Code\n\n-   Blame\n\n79 lines (54 loc) · 3.5 KB\n\n[Raw](https://github.com/y-miyazaki/config/raw/refs/heads/main/AGENTS.md)\n\nCopy raw file\n\nDownload raw file\n\nOutline\n\nEdit and raw actions\n\n# AGENTS.md[](https://github.com/y-miyazaki/config/blob/main/AGENTS.md#agentsmd)\n\nBehavioral rules for AI agents. Self-contained — no external file is required.\n\n---\n\n## Foundation[](https://github.com/y-miyazaki/config/blob/main/AGENTS.md#foundation)\n\n### Priority Order[](https://github.com/y-miyazaki/config/blob/main/AGENTS.md#priority-order)\n\nIf instructions conflict, follow this precedence:\n\n1.  Explicit user instructions\n2.  Repository-specific instructions\n3.  Existing codebase conventions\n4.  General best practices\n\n### Core Principles[](https://github.com/y-miyazaki/config/blob/main/AGENTS.md#core-principles)\n\n-   Prefer minimal, surgical diffs. Do NOT rewrite or touch unrelated code.\n-   Do not perform unrelated refactoring, cleanup, modernization, or optimization unless approved.\n-   Control scope. Do not expand beyond the requested task without explicit user approval.\n-   Never fabricate APIs, commands, paths, or behavior. If uncertain, state \"unknown\".\n-   Evidence-First: Use repository code, docs, and tests as the primary source of truth.\n-   Preserve existing architecture and conventions unless explicitly instructed to change.\n-   Provide honest, critical feedback. State trade-offs and risks clearly.\n-   Clearly identify significant improvement opportunities separately from the requested work.\n\n## Execution[](https://github.com/y-miyazaki/config/blob/main/AGENTS.md#execution)\n\n### Safety[](https://github.com/y-miyazaki/config/blob/main/AGENTS.md#safety)\n\n-   Stop and Ask before: destructive operations, conflicting requirements, unclear specifications, irreversible architectural decisions, security-sensitive ambiguity, or disproportionate cost.\n-   Do not expose secrets, credentials, or sensitive tokens in outputs, logs, or commits.\n-   Do not repeatedly retry failed destructive operations without understanding failure causes.\n-   Write temporary artifacts only to ignored locations. Clean up completely when done.\n\n### Code Modification[](https://github.com/y-miyazaki/config/blob/main/AGENTS.md#code-modification)\n\n-   Read existing code before modifying. Search related implementations and shared interfaces.\n-   Match the project's style, patterns, and conventions.\n-   If an approach fails twice, diagnose root cause and switch strategy. Do not patch incrementally.\n-   Never produce placeholder implementations unless explicitly requested.\n-   Evaluate impact on downstream consumers, APIs, schemas, and automation before changing shared interfaces.\n\n### Verification[](https://github.com/y-miyazaki/config/blob/main/AGENTS.md#verification)\n\n-   Run available verification appropriate to the scope of the change.\n-   If verification cannot be performed, explicitly state what was not verified and why.\n-   Do not claim \"verified\" without evidence.\n-   MUST NOT weaken tests, remove failing tests, or bypass validations solely to make them pass. Determine whether the implementation, expectations, or environment is incorrect.\n\n### Error Handling[](https://github.com/y-miyazaki/config/blob/main/AGENTS.md#error-handling)\n\n-   When encountering unexpected errors, diagnose before retrying. Limit unproductive retries.\n-   If repeated attempts fail, change strategy, simplify, or ask the user.\n-   Report errors specifically and actionably. Avoid vague failure descriptions.\n-   Clearly explain constraints and blockers. Propose next actions or fallback approaches.\n\n## Communication[](https://github.com/y-miyazaki/config/blob/main/AGENTS.md#communication)\n\n### External Knowledge[](https://github.com/y-miyazaki/config/blob/main/AGENTS.md#external-knowledge)\n\n-   Prioritize official documentation and primary sources.\n-   Verify compatibility of external references. Do not rely solely on unverified third-party examples for critical decisions.\n-   Do not include secrets or sensitive data in external queries.\n\n### Decision and Analysis[](https://github.com/y-miyazaki/config/blob/main/AGENTS.md#decision-and-analysis)\n\n-   When proposing multiple options, compare: implementation cost, operational complexity, maintainability, scalability, migration risk, security implications.\n-   For significant decisions, briefly document: chosen approach, rejected alternatives, and reasoning.\n\n### Completion Requirements[](https://github.com/y-miyazaki/config/blob/main/AGENTS.md#completion-requirements)\n\nWhen applicable, explicitly state the following in your final response:\n\n1.  **Implementation:** Overview of changes made.\n2.  **Verification:** Proof of verification performed (or explicit statement of inability).\n3.  **Risks:** Assumptions made and residual risks.\n\nYou can’t perform that action at this time.\n",
  "markdownStats": {
    "images": 0,
    "links": 12,
    "tables": 0,
    "codeBlocks": 0,
    "headings": 12
  },
  "tokens": {
    "htmlTokens": 109165,
    "markdownTokens": 912,
    "reduction": 108253,
    "reductionPercent": 99
  },
  "score": {
    "score": 65,
    "grade": "C",
    "rubricVersion": 2,
    "dimensions": {
      "accessibility": {
        "score": 84,
        "weight": 30,
        "grade": "B",
        "checks": {
          "content_without_js": {
            "score": 100,
            "weight": 55,
            "evidence": "proven",
            "details": "Content available without JavaScript"
          },
          "fast_content_position": {
            "score": 50,
            "weight": 25,
            "evidence": "plausible",
            "details": "Main content starts at 41% of HTML"
          },
          "reasonable_page_size": {
            "score": 80,
            "weight": 20,
            "evidence": "plausible",
            "details": "Page size: 274KB"
          }
        }
      },
      "aiDiscoverability": {
        "score": 55,
        "weight": 25,
        "grade": "D",
        "checks": {
          "robots_allows_ai_bots": {
            "score": 100,
            "weight": 35,
            "evidence": "proven",
            "details": "All major AI search bots allowed"
          },
          "supports_markdown_negotiation": {
            "score": 0,
            "weight": 20,
            "evidence": "plausible",
            "details": "No Markdown for Agents support detected"
          },
          "has_sitemap": {
            "score": 0,
            "weight": 15,
            "evidence": "plausible",
            "details": "No sitemap found"
          },
          "has_robots_txt": {
            "score": 100,
            "weight": 10,
            "evidence": "plausible",
            "details": "robots.txt exists"
          },
          "has_llms_txt": {
            "score": 100,
            "weight": 10,
            "evidence": "speculative",
            "details": "llms.txt exists and is valid"
          },
          "has_content_signals": {
            "score": 0,
            "weight": 10,
            "evidence": "speculative",
            "details": "No Content-Signal found (robots.txt or HTTP headers)"
          }
        }
      },
      "structuredData": {
        "score": 50,
        "weight": 20,
        "grade": "D",
        "checks": {
          "has_schema_org": {
            "score": 0,
            "weight": 35,
            "evidence": "proven",
            "details": "No JSON-LD / Schema.org found"
          },
          "has_open_graph": {
            "score": 100,
            "weight": 20,
            "evidence": "plausible",
            "details": "All OG tags present"
          },
          "has_meta_description": {
            "score": 100,
            "weight": 20,
            "evidence": "plausible",
            "details": "Meta description: 97 chars"
          },
          "has_canonical_url": {
            "score": 0,
            "weight": 15,
            "evidence": "plausible",
            "details": "No canonical URL"
          },
          "has_lang_attribute": {
            "score": 100,
            "weight": 10,
            "evidence": "plausible",
            "details": "lang=\"en\""
          }
        }
      },
      "semanticHtml": {
        "score": 71,
        "weight": 15,
        "grade": "C",
        "checks": {
          "proper_heading_hierarchy": {
            "score": 80,
            "weight": 30,
            "evidence": "plausible",
            "details": "6 <h1> elements (should be 1)"
          },
          "uses_article_or_main": {
            "score": 100,
            "weight": 25,
            "evidence": "plausible",
            "details": "Has both <article> and <main>"
          },
          "semantic_elements": {
            "score": 13,
            "weight": 20,
            "evidence": "plausible",
            "details": "10 semantic elements, 248 divs (ratio: 4%)"
          },
          "meaningful_alt_texts": {
            "score": 100,
            "weight": 15,
            "evidence": "plausible",
            "details": "No images found"
          },
          "low_div_nesting": {
            "score": 44,
            "weight": 10,
            "evidence": "speculative",
            "details": "Avg div depth: 10.6, max: 23"
          }
        }
      },
      "contentEfficiency": {
        "score": 50,
        "weight": 10,
        "grade": "D",
        "checks": {
          "token_reduction_ratio": {
            "score": 100,
            "weight": 40,
            "evidence": "speculative",
            "details": "99% token reduction (HTML→Markdown)"
          },
          "content_to_noise_ratio": {
            "score": 0,
            "weight": 30,
            "evidence": "speculative",
            "details": "Content ratio: 1.2% (3419 content chars / 280880 HTML bytes)"
          },
          "reasonable_page_weight": {
            "score": 50,
            "weight": 20,
            "evidence": "speculative",
            "details": "HTML size: 274KB"
          },
          "minimal_inline_styles": {
            "score": 0,
            "weight": 10,
            "evidence": "speculative",
            "details": "92/1444 elements with inline styles (6.4%)"
          }
        }
      }
    }
  },
  "recommendations": [
    {
      "id": "add_schema_org",
      "priority": "critical",
      "category": "structuredData",
      "titleKey": "rec.add_schema_org.title",
      "descriptionKey": "rec.add_schema_org.description",
      "howToKey": "rec.add_schema_org.howto",
      "effort": "moderate",
      "estimatedImpact": 7,
      "maxImpact": 7,
      "evidence": "proven",
      "checkScore": 0,
      "checkDetails": "No JSON-LD / Schema.org found"
    },
    {
      "id": "add_markdown_negotiation",
      "priority": "critical",
      "category": "aiDiscoverability",
      "titleKey": "rec.add_markdown_negotiation.title",
      "descriptionKey": "rec.add_markdown_negotiation.description",
      "howToKey": "rec.add_markdown_negotiation.howto",
      "effort": "significant",
      "estimatedImpact": 5,
      "maxImpact": 5,
      "evidence": "plausible",
      "checkScore": 0,
      "checkDetails": "No Markdown for Agents support detected"
    },
    {
      "id": "add_sitemap",
      "priority": "high",
      "category": "aiDiscoverability",
      "titleKey": "rec.add_sitemap.title",
      "descriptionKey": "rec.add_sitemap.description",
      "howToKey": "rec.add_sitemap.howto",
      "effort": "quick-win",
      "estimatedImpact": 3.8,
      "maxImpact": 3.8,
      "evidence": "plausible",
      "checkScore": 0,
      "checkDetails": "No sitemap found"
    },
    {
      "id": "add_canonical_url",
      "priority": "high",
      "category": "structuredData",
      "titleKey": "rec.add_canonical_url.title",
      "descriptionKey": "rec.add_canonical_url.description",
      "howToKey": "rec.add_canonical_url.howto",
      "effort": "quick-win",
      "estimatedImpact": 3,
      "maxImpact": 3,
      "evidence": "plausible",
      "checkScore": 0,
      "checkDetails": "No canonical URL"
    },
    {
      "id": "improve_content_ratio",
      "priority": "high",
      "category": "contentEfficiency",
      "titleKey": "rec.improve_content_ratio.title",
      "descriptionKey": "rec.improve_content_ratio.description",
      "howToKey": "rec.improve_content_ratio.howto",
      "effort": "moderate",
      "estimatedImpact": 3,
      "maxImpact": 3,
      "evidence": "speculative",
      "checkScore": 0,
      "checkDetails": "Content ratio: 1.2% (3419 content chars / 280880 HTML bytes)"
    },
    {
      "id": "add_semantic_elements",
      "priority": "high",
      "category": "semanticHtml",
      "titleKey": "rec.add_semantic_elements.title",
      "descriptionKey": "rec.add_semantic_elements.description",
      "howToKey": "rec.add_semantic_elements.howto",
      "effort": "moderate",
      "estimatedImpact": 2.6,
      "maxImpact": 3,
      "evidence": "plausible",
      "checkScore": 13,
      "checkDetails": "10 semantic elements, 248 divs (ratio: 4%)"
    },
    {
      "id": "add_content_signals",
      "priority": "high",
      "category": "aiDiscoverability",
      "titleKey": "rec.add_content_signals.title",
      "descriptionKey": "rec.add_content_signals.description",
      "howToKey": "rec.add_content_signals.howto",
      "effort": "quick-win",
      "estimatedImpact": 2.5,
      "maxImpact": 2.5,
      "evidence": "speculative",
      "checkScore": 0,
      "checkDetails": "No Content-Signal found (robots.txt or HTTP headers)"
    },
    {
      "id": "remove_inline_styles",
      "priority": "medium",
      "category": "contentEfficiency",
      "titleKey": "rec.remove_inline_styles.title",
      "descriptionKey": "rec.remove_inline_styles.description",
      "howToKey": "rec.remove_inline_styles.howto",
      "effort": "moderate",
      "estimatedImpact": 1,
      "maxImpact": 1,
      "evidence": "speculative",
      "checkScore": 0,
      "checkDetails": "92/1444 elements with inline styles (6.4%)"
    },
    {
      "id": "reduce_div_nesting",
      "priority": "low",
      "category": "semanticHtml",
      "titleKey": "rec.reduce_div_nesting.title",
      "descriptionKey": "rec.reduce_div_nesting.description",
      "howToKey": "rec.reduce_div_nesting.howto",
      "effort": "significant",
      "estimatedImpact": 0.8,
      "maxImpact": 1.5,
      "evidence": "speculative",
      "checkScore": 44,
      "checkDetails": "Avg div depth: 10.6, max: 23"
    }
  ],
  "llmsTxtPreview": "# GitHub\n\n> A repository of initial settings around the editor - config/AGENTS.md at main · y-miyazaki/config\n\n## Documentation\n- [Sign in](https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fy-miyazaki%2Fconfig%2Fblob%2Fmain%2FAGENTS.md)\n- [History](https://github.com/y-miyazaki/config/commits/main/AGENTS.md)\n- [Raw](https://github.com/y-miyazaki/config/raw/refs/heads/main/AGENTS.md)\n\n## Main\n- [config/AGENTS.md at main · y-miyazaki/config](https://github.com/y-miyazaki/config/blob/main/AGENTS.md): A repository of initial settings around the editor - config/AGENTS.md at main · y-miyazaki/config\n- [GitHub CopilotWrite better code with AI](https://github.com/features/copilot)\n- [GitHub Copilot appDirect agents from issue to merge](https://github.com/features/ai/github-app)\n- [ActionsAutomate any workflow](https://github.com/features/actions)\n- [CodespacesInstant dev environments](https://github.com/features/codespaces)\n- [IssuesPlan and track work](https://github.com/features/issues)\n- [Code ReviewManage code changes](https://github.com/features/code-review)\n- [Code QualityEnforce quality at merge](https://github.com/features/code-quality)\n- [View all features](https://github.com/features)\n- [Small and medium teams](https://github.com/team)\n- [Nonprofits](https://github.com/solutions/industry/nonprofits)\n- [App Modernization](https://github.com/solutions/use-case/app-modernization)\n- [DevSecOps](https://github.com/solutions/use-case/devsecops)\n- [DevOps](https://github.com/solutions/use-case/devops)\n- [CI/CD](https://github.com/solutions/use-case/ci-cd)\n- [View all use cases](https://github.com/solutions/use-case)\n- [Healthcare](https://github.com/solutions/industry/healthcare)\n- [Financial services](https://github.com/solutions/industry/financial-services)\n- [Manufacturing](https://github.com/solutions/industry/manufacturing)\n- [Government](https://github.com/solutions/industry/government)\n- [View all industries](https://github.com/solutions/industry)\n- [View all solutions](https://github.com/solutions)\n- [Business insights](https://github.com/solutions/executive-insights)\n- [Copilot for BusinessEnterprise-grade AI features](https://github.com/features/copilot/copilot-business)\n- [Pricing](https://github.com/pricing)\n- [Sign in](https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fy-miyazaki%2Fconfig%2Fblob%2Fmain%2FAGENTS.md)\n- [MCP RegistryIntegrate external tools](https://github.com/mcp)\n- [GitHub Advanced SecurityFind and fix vulnerabilities](https://github.com/security/advanced-security)\n- [Code securitySecure your code as you build](https://github.com/security/advanced-security/code-security)\n- [Secret protectionStop leaks before they start](https://github.com/security/advanced-security/secret-protection)\n- [Why GitHub](https://github.com/why-github)\n- [Marketplace](https://github.com/marketplace)\n- [Enterprises](https://github.com/enterprise)\n\n## Blog\n- [AI](https://github.com/resources/articles?topic=ai)\n- [Software Development](https://github.com/resources/articles?topic=software-development)\n- [DevOps](https://github.com/resources/articles?topic=devops)\n- [Security](https://github.com/resources/articles?topic=security)\n- [View all topics](https://github.com/resources/articles)\n\n",
  "llmsTxtExisting": "# GitHub\n\n> GitHub is a developer platform for building, shipping, and maintaining software. It provides cloud-based Git repository hosting, CI/CD via GitHub Actions, project management with Issues and Projects, code review via pull requests, AI-powered development with GitHub Copilot, and APIs (REST and GraphQL) for automation and integration.\n\n## How to use\n\nTo retrieve full article content, page lists, or search results programmatically, please use the APIs below. To find a specific article, use the **Search API** with a query. To browse all available pages, use the **Page List API** to get a list of paths, then fetch individual articles with the **Article API**. The `/api/article/body` endpoint returns markdown, ideal for LLM consumption. These APIs return structured markdown and JSON and are the preferred way for LLMs and automated tools to access GitHub documentation.\n\n* [Versions API](https://docs.github.com/api/pagelist/versions): Lists all available documentation versions.\n* [Languages API](https://docs.github.com/api/pagelist/languages): Lists all available languages.\n* [Page List API](https://docs.github.com/api/pagelist/en/free-pro-team@latest): Returns every docs page path for a given language and version.\n* [Article API](https://docs.github.com/api/article): Returns the full rendered content and context of any docs page as JSON. Example: `curl \"https://docs.github.com/api/article?pathname=/en/get-started/start-your-journey/about-github-and-git\"`\n* [Article Body API](https://docs.github.com/api/article/body): Returns the full rendered content of any docs page as markdown. Example: `curl \"https://docs.github.com/api/article/body?pathname=/en/get-started/start-your-journey/about-github-and-git\"`\n* [Search API](https://docs.github.com/api/search/v1): Search across all docs content. Example: `curl \"https://docs.github.com/api/search/v1?query=actions&language=en&version=free-pro-team@latest\"`\n* [GitHub MCP server](https://github.com/github/github-mcp-server): For agents that connect via Model Context Protocol, the GitHub MCP server provides tools for working with GitHub itself: repositories, issues, pull requests, workflows, and code. It does not currently include docs search.\n\n## Building with GitHub, for coding agents and automation\n\n* [Extend Copilot Chat with MCP](https://docs.github.com/en/copilot/how-tos/provide-context/use-mcp-in-your-ide/extend-copilot-chat-with-mcp): Connect MCP servers to Copilot Chat to share context from other applications.\n* [Use the GitHub MCP Server](https://docs.github.com/en/copilot/how-tos/provide-context/use-mcp-in-your-ide/use-the-github-mcp-server): Learn how to use the GitHub Model Context Protocol (MCP) server to interact with repositories, issues, pull requests, and other GitHub features, directly from Copilot Chat in your IDE.\n* [Set up the GitHub MCP Server](https://docs.github.com/en/copilot/how-tos/provide-context/use-mcp-in-your-ide/set-up-the-github-mcp-server): Learn how to configure the GitHub Model Context Protocol (MCP) server.\n* [About cloud agent](https://docs.github.com/en/copilot/concepts/agents/cloud-agent/about-cloud-agent): Copilot can research a repository, create an implementation plan, and make code changes on a branch. You can review the diff, iterate, and create a pull request when you're ready.\n* [Create custom agents in your IDE](https://docs.github.com/en/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents-in-your-ide): You can create specialized agents with tailored expertise for specific development tasks.\n* [GitHub CLI](https://docs.github.com/en/github-cli/github-cli): GitHub CLI is an open source tool for using GitHub from your computer's command line. When you're working from the command line, you can use the GitHub CLI to save time and avoid switching context.\n* [Quickstart](https://docs.github.com/en/github-cli/github-cli/quickstart): Start using GitHub CLI to work with GitHub in the command line.\n* [REST API](https://docs.github.com/en/rest): Create integrations, retrieve data, and automate your workflows with the GitHub REST API.\n* [GraphQL API](https://docs.github.com/en/graphql): To create integrations, retrieve data, and automate your workflows, use the GitHub GraphQL API. The GitHub GraphQL API offers more precise and flexible queries than the GitHub REST API.\n* [GitHub Actions](https://docs.github.com/en/actions): Automate, customize, and execute your software development workflows right in your repository with GitHub Actions. You can discover, create, and share actions to perform any job you'd like, including CI/CD, and combine actions in a completely customized workflow.\n\n## GitHub Copilot\n\n> You can use GitHub Copilot to enhance your productivity and assist as you work on code.\n\n* [GitHub Copilot](https://docs.github.com/en/copilot): You can use GitHub Copilot to enhance your productivity and assist as you work on code.\n* [Copilot requests](https://docs.github.com/en/copilot/concepts/billing/copilot-requests): Learn about requests in Copilot, including premium requests, how they work, and how to manage your usage effectively.\n* [Individual plans](https://docs.github.com/en/copilot/concepts/billing/individual-plans): GitHub offers several Copilot plans for individual developers, each with different features, model access, and usage limits to support a wide range of coding needs.\n* [Usage-based billing for individuals](https://docs.github.com/en/copilot/concepts/billing/usage-based-billing-for-individuals): Your Copilot plan will include a monthly allowance of GitHub AI Credits. If you exhaust your AI credits, you can pay extra to keep working.\n* [Usage-based billing for organizations and enterprises](https://docs.github.com/en/copilot/concepts/billing/usage-based-billing-for-organizations-and-enterprises): Prepare for the transition to usage-based billing for Copilot Business and Copilot Enterprise.\n* [Usage limits](https://docs.github.com/en/copilot/concepts/usage-limits): Learn about GitHub Copilot usage limits and what to do if you hit a limit.\n* [Features](https://docs.github.com/en/copilot/get-started/features): GitHub Copilot offers a suite of features for users and administrators.\n* [Plans](https://docs.github.com/en/copilot/get-started/plans): Learn about the available plans for Copilot.\n* [Quickstart](https://docs.github.com/en/copilot/get-started/quickstart): Quickly learn how to use GitHub Copilot.\n* [What is GitHub Copilot?](https://docs.github.com/en/copilot/get-started/what-is-github-copilot): Learn what Copilot is and what you can do with it.\n* [Copilot CLI best practices](https://docs.github.com/en/copilot/how-tos/copilot-cli/cli-best-practices): Learn how to get the most out of GitHub Copilot CLI.\n* [Install Copilot CLI](https://docs.github.com/en/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli): Learn how to install Copilot CLI so that you can use Copilot directly from the command line.\n* [Overview](https://docs.github.com/en/copilot/how-tos/copilot-cli/use-copilot-cli/overview): Learn how to use GitHub Copilot from the command line.\n* [Add repository instructions](https://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions): Create repository custom instructions files that give Copilot additional context on how to understand your project and how to build, test and validate its changes.\n* [Set up for students](https://docs.github.com/en/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-students): Get free access to Copilot's premium features as a verified student.\n* [Get IDE code suggestions](https://docs.github.com/en/copilot/how-tos/get-code-suggestions/get-ide-code-suggestions): Use GitHub Copilot to get code suggestions in your editor.\n* [Preparing for usage-based billing](https://docs.github.com/en/copilot/how-tos/manage-and-track-spending/prepare-for-your-move-to-usage-based-billing): If you're on a Copilot Pro or Copilot Pro+ plan, review your estimated costs under usage-based billing and take steps to prepare before the transition.\n* [Troubleshoot common issues](https://docs.github.com/en/copilot/how-tos/troubleshoot-copilot/troubleshoot-common-issues): This guide describes the most common issues with GitHub Copilot and how to resolve them.\n* [Use code review](https://docs.github.com/en/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review): Learn how to request a code review from GitHub Copilot.\n* [Supported models](https://docs.github.com/en/copilot/reference/ai-models/supported-models): Learn about the supported AI models in GitHub Copilot.\n* [Models and pricing](https://docs.github.com/en/copilot/reference/copilot-billing/models-and-pricing): See per-token pricing for the models available in GitHub Copilot and reference rates for additional usage across plans.\n* [Chat in GitHub](https://docs.github.com/en/copilot/responsible-use/chat-in-github): Learn how to use GitHub Copilot Chat in GitHub responsibly by understanding its purposes, capabilities, and limitations.\n* [Chat in GitHub Mobile](https://docs.github.com/en/copilot/responsible-use/chat-in-github-mobile): Learn how to use GitHub Copilot Chat responsibly by understanding its purposes, capabilities, and limitations.\n* [GitHub Copilot Cookbook](https://docs.github.com/en/copilot/tutorials/copilot-cookbook): Learn how to use GitHub Copilot to accomplish specific tasks.\n\n## Get started\n\n> Learn how to start building, shipping, and maintaining software with GitHub. Explore our products, sign up for an account, and connect with the world's largest development community.\n\n* [Get started](https://docs.github.com/en/get-started): Learn how to start building, shipping, and maintaining software with GitHub. Explore our products, sign up for an account, and connect with the world's largest development community.\n* [About remote repositories](https://docs.github.com/en/get-started/git-basics/about-remote-repositories): GitHub's collaborative approach to development depends on publishing commits from your local repository to GitHub for other people to view, fetch, and update.\n* [Ignoring files](https://docs.github.com/en/get-started/git-basics/ignoring-files): You can configure Git to ignore files you don't want to check in to GitHub.\n* [Manage remote repositories](https://docs.github.com/en/get-started/git-basics/managing-remote-repositories): Learn to work with your local repositories on your computer and remote repositories hosted on GitHub.\n* [Set up Git](https://docs.github.com/en/get-started/git-basics/set-up-git): At the heart of GitHub is an open-source version control system (VCS) called Git. Git is responsible for everything GitHub-related that happens locally on your computer.\n* [GitHub's plans](https://docs.github.com/en/get-started/learning-about-github/githubs-plans): An overview of GitHub's pricing plans.\n* [Types of GitHub accounts](https://docs.github.com/en/get-started/learning-about-github/types-of-github-accounts): Accounts on GitHub allow you to organize and control access to code.\n* [Start your journey](https://docs.github.com/en/get-started/start-your-journey): Brand new to GitHub? Learn the basics here.\n* [About GitHub and Git](https://docs.github.com/en/get-started/start-your-journey/about-github-and-git): You can use GitHub and Git to collaborate on work.\n* [Create an account](https://docs.github.com/en/get-started/start-your-journey/creating-an-account-on-github): Create a personal account to get started with GitHub.\n* [Download files](https://docs.github.com/en/get-started/start-your-journey/downloading-files-from-github): Learn how to download files from GitHub, and understand the difference between downloading, cloning, and forking.\n* [Hello World](https://docs.github.com/en/get-started/start-your-journey/hello-world): Follow this Hello World exercise to learn GitHub's pull request workflow.\n* [Docs versions](https://docs.github.com/en/get-started/using-github-docs/about-versions-of-github-docs): You can read documentation that reflects the GitHub product you're currently using.\n* [Connectivity problems](https://docs.github.com/en/get-started/using-github/troubleshooting-connectivity-problems): If you're having trouble connecting to GitHub, you can troubleshoot your connection, then use the GitHub Debug tool to diagnose problems.\n* [Basic formatting syntax](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax): Create sophisticated formatting for your prose and code on GitHub with simple syntax.\n\n## Authentication\n\n> Authenticate securely to GitHub with passwords, tokens, SSH keys, and more—and keep your account protected.\n\n* [Connect with SSH](https://docs.github.com/en/authentication/connecting-to-github-with-ssh): You can connect to GitHub using the Secure Shell Protocol (SSH), which provides a secure channel over an unsecured network.\n* [Add a new SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account): To configure your account on GitHub.com to use your new (or existing) SSH key, you'll also need to add the key to your account.\n* [Check for existing SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys): Before you generate an SSH key, you can check to see if you have any existing SSH keys.\n* [Generate new SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent): After you've checked for existing SSH keys, you can generate a new SSH key to use for authentication, then add it to the ssh-agent.\n* [Managing deploy keys](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/managing-deploy-keys): Learn different ways to manage SSH keys on your servers when you automate deployment scripts and which way is best for you.\n* [Test your SSH connection](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection): After you've set up your SSH key and added it to GitHub, you can test your connection.\n* [Authentication to GitHub](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/about-authentication-to-github): You can securely access your account's resources by authenticating to GitHub, using different credentials depending on where you authenticate.\n* [Manage personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens): You can use a personal access token in place of a password when authenticating to GitHub in the command line or with the API.\n* [Displaying verification for all commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits): You can enable vigilant mode for commit signature verification to mark all of your commits and tags with a signature verification status.\n* [Configure 2FA](https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication): You can choose among multiple options to add a second source of authentication to your account.\n* [Configure 2FA recovery](https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication-recovery-methods): You can set up a variety of recovery methods to access your account if you lose your two-factor authentication credentials.\n* [Recover an account with 2FA](https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials): If you lose access to your two-factor authentication credentials, you can use your recovery codes, or another recovery option, to regain access to your account.\n\n## GitHub Pages\n\n> GitHub Pages turns any GitHub repository into a live website—no separate hosting required.\n\n* [GitHub Pages](https://docs.github.com/en/pages): GitHub Pages turns any GitHub repository into a live website—no separate hosting required.\n* [Configure a custom domain](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site): You can customize the domain name of your GitHub Pages site.\n* [Custom domains in GitHub Pages](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages): GitHub Pages supports using custom domains, or changing the root of your site's URL from the default, like octocat.github.io, to any domain you own.\n* [Manage a custom domain](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site): You can set up or update certain DNS records and your repository settings to point the default domain for your GitHub Pages site to a custom domain.\n* [Configure publishing source](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site): You can configure your GitHub Pages site to publish when changes are pushed to a specific branch, or you can write a GitHub Actions workflow to publish your site.\n* [Create a GitHub Pages site](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site): You can create a GitHub Pages site in a new or existing repository.\n* [What is GitHub Pages?](https://docs.github.com/en/pages/getting-started-with-github-pages/what-is-github-pages): You can use GitHub Pages to host a website about yourself, your organization, or your project directly from a repository on GitHub.\n* [Quickstart](https://docs.github.com/en/pages/quickstart): You can use GitHub Pages to showcase some open source projects, host a blog, or even share your résumé. This guide will help get you started on creating your next website.\n* [Add theme to Pages site](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll): You can personalize your Jekyll site by adding and customizing a theme.\n* [Add content to Pages site](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll): You can add a new page or post to your Jekyll site on GitHub Pages.\n\n## Account and profile\n\n> Make GitHub work best for you by customizing your personal account settings and personalizing your profile page.\n\n* [Account and profile](https://docs.github.com/en/account-and-profile): Make GitHub work best for you by customizing your personal account settings and personalizing your profile page.\n* [Username changes](https://docs.github.com/en/account-and-profile/concepts/username-changes): You can change the username for your GitHub account.\n* [How-tos](https://docs.github.com/en/account-and-profile/how-tos): Learn how to accomplish specific tasks for your GitHub account and profile.\n* [Manage cookie preferences](https://docs.github.com/en/account-and-profile/how-tos/account-settings/manage-cookie-preferences): You can control how GitHub uses information from non-essential tracking cookies for enterprise marketing pages.\n* [Troubleshoot missing contributions](https://docs.github.com/en/account-and-profile/how-tos/contribution-settings/troubleshooting-missing-contributions): Learn common reasons that contributions may be missing from your contributions graph.\n* [Primary email address](https://docs.github.com/en/account-and-profile/how-tos/email-preferences/changing-your-primary-email-address): To change your primary email address, you'll add a new email, then delete the old one.\n* [Set commit email address](https://docs.github.com/en/account-and-profile/how-tos/email-preferences/setting-your-commit-email-address): You can set the email address that is used to author commits on GitHub and on your computer.\n* [Personalize your profile](https://docs.github.com/en/account-and-profile/tutorials/personalize-your-profile): You can share information about yourself with other users by setting a profile picture and adding a bio to your profile.\n\n## Repositories\n\n> Learn to use and manage the repositories that allow you to store and collaborate on your project's code.\n\n* [About rulesets](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets): Rulesets help you to control how people can interact with branches and tags in a repository.\n* [About repositories](https://docs.github.com/en/repositories/creating-and-managing-repositories/about-repositories): A repository contains all of your code, your files, and each file's revision history. You can discuss and manage your work within the repository.\n* [Cloning a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository): When you create a repository on GitHub, it exists as a remote repository. You can clone your repository to create a local copy on your computer and sync between the two locations.\n* [Quickstart for repositories](https://docs.github.com/en/repositories/creating-and-managing-repositories/quickstart-for-repositories): Learn how to create a new repository and commit your first change in 5 minutes.\n* [About READMEs](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes): You can add a README file to your repository to tell other people why your project is useful, what they can do with your project, and how they can use it.\n* [Licensing a repository](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository): Public repositories on GitHub are often used to share open source software. For your repository to truly be open source, you'll need to license it so that others are free to use, change, and distribute the software.\n* [About releases](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases): You can create a release to package software, along with release notes and links to binary files, for other people to use.\n\n## Apps\n\n> Go deeper with GitHub by integrating with our APIs and webhooks, customizing your GitHub workflow, and building and sharing apps with the community.\n\n* [About creating apps](https://docs.github.com/en/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps): GitHub Apps let you build integrations to automate processes and extend GitHub's functionality.\n* [Writing code for a GitHub App](https://docs.github.com/en/apps/creating-github-apps/writing-code-for-a-github-app): Learn about using the GitHub API with your app, continuous integration, and how to build with apps.\n* [Maintaining GitHub Apps](https://docs.github.com/en/apps/maintaining-github-apps): After you create and register a GitHub App, you can make modifications to the app, change permissions, transfer ownership, and delete the app.\n* [Authorizing OAuth apps](https://docs.github.com/en/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps): You can connect your GitHub identity to third-party applications using OAuth. When authorizing an OAuth app, you should ensure you trust the application, review who it's developed by, and review the kinds of information the application wants to access.\n* [Authorize](https://docs.github.com/en/apps/using-github-apps/authorizing-github-apps): You can authorize a GitHub App to retrieve information about your GitHub account and to make changes on your behalf.\n\n## GitHub Actions\n\n> Automate, customize, and execute your software development workflows right in your repository with GitHub Actions. You can discover, create, and share actions to perform any job you'd like, including CI/CD, and combine actions in a completely customized workflow.\n\n* [Quickstart](https://docs.github.com/en/actions/get-started/quickstart): Try out the core features of GitHub Actions in minutes.\n* [Understand GitHub Actions](https://docs.github.com/en/actions/get-started/understand-github-actions): Learn the basics of core concepts and essential terminology in GitHub Actions.\n* [Workflow syntax](https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax): A workflow is a configurable automated process made up of one or more jobs. You must create a YAML file to define your workflow configuration.\n\n## Pull requests\n\n> Learn how to use pull requests to suggest changes to a project, receive suggested changes to your own projects, and address issues in pull requests, such as merge conflicts.\n\n* [Compare branches](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests): Pull requests display diffs to compare the changes you made in your topic branch against the base branch that you want to merge your changes into.\n* [About pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests): Pull requests let you propose, review, and merge code changes.\n* [Fork a repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo): A fork is a new repository that shares code and visibility settings with the original upstream repository.\n\n## More pages\n\n* [GitHub Actions](https://docs.github.com/en/billing/concepts/product-billing/github-actions): Learn how usage of GitHub Actions is measured against your free allowance and how to pay for additional use.\n* [GitHub Models](https://docs.github.com/en/billing/concepts/product-billing/github-models): If you want to use GitHub Models beyond the free usage included in your account, you can choose to opt in to paid usage.\n* [Configure security updates](https://docs.github.com/en/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-dependabot-security-updates): You can use Dependabot security updates or manual pull requests to easily update vulnerable dependencies.\n* [Codespaces](https://docs.github.com/en/codespaces): Create a codespace to start developing in a secure, configurable, and dedicated development environment that works how and where you want it to.\n* [Installation](https://docs.github.com/en/desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop): You can install GitHub Desktop on supported Windows or macOS operating systems.\n* [Prototype with AI models](https://docs.github.com/en/github-models/use-github-models/prototyping-with-ai-models): Find and experiment with AI models for free.\n* [About Projects](https://docs.github.com/en/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects): Projects is an adaptable, flexible tool for planning and tracking work on GitHub.\n* [About GitHub Importer](https://docs.github.com/en/migrations/importing-source-code/using-github-importer/about-github-importer): If your source code is stored on another Git-based hosting service, you can move the code to GitHub.com using GitHub Importer.\n* [OAuth app restrictions](https://docs.github.com/en/organizations/managing-oauth-access-to-your-organizations-data/about-oauth-app-access-restrictions): Organizations can choose which OAuth apps have access to their repositories and other resources by enabling OAuth app access restrictions.\n* [Container registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry): You can store and manage Docker and OCI images in the Container registry.\n* [Authenticating](https://docs.github.com/en/rest/authentication/authenticating-to-the-rest-api): You can authenticate to the REST API to access more endpoints and have a higher rate limit.\n* [Permissions for fine-grained PATs](https://docs.github.com/en/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens): For each permission granted to a fine-grained personal access token, these are the REST API endpoints that the app can use.\n* [Code search syntax](https://docs.github.com/en/search-github/github-code-search/understanding-github-code-search-syntax): You can build search queries for the results you want with specialized code qualifiers, regular expressions, and boolean operations.\n\n<!-- This file is automatically generated. Do not edit manually. -->",
  "emergingProtocols": {
    "oauthProtectedResource": {
      "exists": false,
      "url": "https://github.com/.well-known/oauth-protected-resource"
    },
    "oauthDiscovery": {
      "exists": false,
      "url": "https://github.com/.well-known/oauth-authorization-server"
    },
    "mcpServerCard": {
      "exists": false,
      "url": "https://github.com/.well-known/mcp/server-card.json",
      "draft": true
    },
    "a2aAgentCard": {
      "exists": false,
      "url": "https://github.com/.well-known/agent-card.json"
    },
    "apiCatalog": {
      "exists": false,
      "url": "https://github.com/.well-known/api-catalog"
    },
    "agentSkills": {
      "exists": false,
      "url": "https://github.com/.well-known/agent-skills/index.json",
      "draft": true
    },
    "count": 0,
    "total": 6
  },
  "botAccess": {
    "probed": true,
    "bot": "OAI-SearchBot",
    "controlStatus": 200,
    "botStatus": 200,
    "discriminates": false,
    "refusedAsBot": false,
    "edge": null,
    "verifiable": false,
    "detail": "This origin answers OAI-SearchBot exactly as it answers any other client (200). No edge-level filtering of AI crawlers observed."
  },
  "snippets": [
    {
      "id": "add_canonical_url",
      "title": "Add canonical URL",
      "description": "The canonical URL tells AI agents which version of the page is the \"official\" one, avoiding duplicate content issues.",
      "language": "html",
      "code": "<link rel=\"canonical\" href=\"https://github.com/y-miyazaki/config/blob/main/AGENTS.md\">",
      "filename": "<head>"
    },
    {
      "id": "add_schema_org",
      "title": "Add Schema.org JSON-LD",
      "description": "Structured data helps AI agents understand the type, author, and purpose of your content.",
      "language": "html",
      "code": "<script type=\"application/ld+json\">\n{\n  \"@context\": \"https://schema.org\",\n  \"@type\": \"WebPage\",\n  \"name\": \"config/AGENTS.md at main · y-miyazaki/config\",\n  \"description\": \"A repository of initial settings around the editor - config/AGENTS.md at main · y-miyazaki/config\",\n  \"url\": \"https://github.com/y-miyazaki/config/blob/main/AGENTS.md\",\n  \"inLanguage\": \"en\",\n  \"isPartOf\": {\n    \"@type\": \"WebSite\",\n    \"name\": \"GitHub\"\n  }\n}\n</script>",
      "filename": "<head>"
    },
    {
      "id": "add_sitemap",
      "title": "Create /sitemap.xml",
      "description": "A sitemap helps AI agents discover all your pages. Most CMS platforms generate one automatically.",
      "language": "xml",
      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<urlset xmlns=\"http://www.sitemaps.org/schemas/sitemap/0.9\">\n  <url>\n    <loc>https://github.com/y-miyazaki/config/blob/main/AGENTS.md</loc>\n    <lastmod>2026-07-29</lastmod>\n  </url>\n</urlset>",
      "filename": "/sitemap.xml"
    },
    {
      "id": "add_content_signals",
      "title": "Add Content-Signal directives",
      "description": "Content-Signal tells AI agents how they may use your content. The canonical location is robots.txt, but you can also expose it as an HTTP header from any stack.",
      "language": "txt",
      "code": "User-agent: *\nContent-Signal: search=yes, ai-input=yes, ai-train=no",
      "filename": "/robots.txt",
      "stacks": [
        {
          "id": "robots",
          "label": "robots.txt",
          "language": "txt",
          "filename": "/robots.txt",
          "code": "User-agent: *\nContent-Signal: search=yes, ai-input=yes, ai-train=no"
        },
        {
          "id": "nginx",
          "label": "Nginx",
          "language": "nginx",
          "filename": "server block",
          "code": "# Inside your server { } block:\nadd_header Content-Signal \"search=yes, ai-input=yes, ai-train=no\" always;"
        },
        {
          "id": "apache",
          "label": "Apache",
          "language": "apache",
          "filename": ".htaccess",
          "code": "# In .htaccess (or VirtualHost):\nHeader set Content-Signal \"search=yes, ai-input=yes, ai-train=no\""
        },
        {
          "id": "wordpress",
          "label": "WordPress",
          "language": "php",
          "filename": "functions.php",
          "code": "<?php\n// In your theme's functions.php or a small mu-plugin\nadd_action('send_headers', function () {\n    header('Content-Signal: search=yes, ai-input=yes, ai-train=no');\n});\n\n// Optional: also append the directive to the dynamic robots.txt\nadd_filter('robots_txt', function ($output) {\n    return $output . \"\\nContent-Signal: search=yes, ai-input=yes, ai-train=no\\n\";\n}, 10, 1);"
        },
        {
          "id": "nextjs",
          "label": "Next.js",
          "language": "typescript",
          "filename": "middleware.ts",
          "code": "// middleware.ts (Next.js 13+ App Router or Pages Router)\nimport { NextResponse } from 'next/server';\nexport function middleware() {\n  const res = NextResponse.next();\n  res.headers.set(\n    'Content-Signal',\n    'search=yes, ai-input=yes, ai-train=no'\n  );\n  return res;\n}\nexport const config = { matcher: '/:path*' };"
        },
        {
          "id": "cloudflare",
          "label": "Cloudflare Workers",
          "language": "javascript",
          "filename": "worker.js",
          "code": "// Cloudflare Worker that proxies your origin and adds the header\nexport default {\n  async fetch(request, env, ctx) {\n    const res = await fetch(request);\n    const newRes = new Response(res.body, res);\n    newRes.headers.set(\n      'Content-Signal',\n      'search=yes, ai-input=yes, ai-train=no'\n    );\n    return newRes;\n  },\n};"
        },
        {
          "id": "express",
          "label": "Express / Fastify",
          "language": "javascript",
          "filename": "server.js",
          "code": "// Express\napp.use((req, res, next) => {\n  res.setHeader('Content-Signal', 'search=yes, ai-input=yes, ai-train=no');\n  next();\n});\n\n// Fastify\nfastify.addHook('onSend', (request, reply, payload, done) => {\n  reply.header('Content-Signal', 'search=yes, ai-input=yes, ai-train=no');\n  done();\n});"
        }
      ]
    },
    {
      "id": "add_markdown_negotiation",
      "title": "Support Markdown for Agents",
      "description": "Let AI agents request a clean Markdown version of any page via content negotiation, .md alternate URLs, link tags or Link headers.",
      "language": "html",
      "code": "<!-- Mechanism 3: link tag advertising the .md alternate -->\n<link rel=\"alternate\" type=\"text/markdown\" href=\"/page.md\">",
      "filename": "<head>",
      "stacks": [
        {
          "id": "html",
          "label": "HTML <head>",
          "language": "html",
          "filename": "<head>",
          "code": "<!-- Mechanism 3: link tag advertising the .md alternate -->\n<link rel=\"alternate\" type=\"text/markdown\" href=\"/page.md\">"
        },
        {
          "id": "express",
          "label": "Express",
          "language": "javascript",
          "filename": "server.js",
          "code": "// Mechanisms 1 + 4: content negotiation + Link header\napp.get('/page', (req, res) => {\n  res.setHeader('Vary', 'Accept');\n  res.setHeader('Link', '</page.md>; rel=\"alternate\"; type=\"text/markdown\"');\n  if ((req.headers.accept || '').includes('text/markdown')) {\n    res.type('text/markdown; charset=utf-8');\n    return res.send(renderMarkdown('page'));\n  }\n  res.render('page');\n});"
        },
        {
          "id": "fastify",
          "label": "Fastify",
          "language": "javascript",
          "filename": "server.js",
          "code": "// Mechanisms 1 + 4: content negotiation + Link header\nfastify.get('/page', async (req, reply) => {\n  reply.header('Vary', 'Accept');\n  reply.header('Link', '</page.md>; rel=\"alternate\"; type=\"text/markdown\"');\n  if ((req.headers.accept || '').includes('text/markdown')) {\n    return reply.type('text/markdown; charset=utf-8').send(renderMarkdown('page'));\n  }\n  return reply.view('/page.ejs');\n});"
        },
        {
          "id": "nextjs",
          "label": "Next.js",
          "language": "typescript",
          "filename": "app/page/route.ts",
          "code": "// Next.js App Router — Route Handler returning Markdown\nimport { NextRequest } from 'next/server';\nimport { renderMarkdown } from '@/lib/md';\nexport async function GET(req: NextRequest) {\n  const accept = req.headers.get('accept') || '';\n  if (accept.includes('text/markdown')) {\n    return new Response(await renderMarkdown('page'), {\n      headers: {\n        'Content-Type': 'text/markdown; charset=utf-8',\n        'Vary': 'Accept',\n      },\n    });\n  }\n  // Fall through to the page component\n  return new Response(null, { status: 404 });\n}"
        },
        {
          "id": "wordpress",
          "label": "WordPress",
          "language": "php",
          "filename": "functions.php",
          "code": "<?php\n// Mechanism 1: respond to Accept: text/markdown on the same URL\nadd_action('template_redirect', function () {\n    if (!is_singular()) return;\n    $accept = $_SERVER['HTTP_ACCEPT'] ?? '';\n    if (strpos($accept, 'text/markdown') === false) return;\n    header('Content-Type: text/markdown; charset=utf-8');\n    header('Vary: Accept');\n    $post = get_queried_object();\n    echo \"# \" . get_the_title($post) . \"\\n\\n\";\n    echo wp_strip_all_tags(apply_filters('the_content', $post->post_content));\n    exit;\n});"
        },
        {
          "id": "static",
          "label": "Hugo / Jekyll / Astro",
          "language": "txt",
          "filename": "static/page.md",
          "code": "# Mechanism 2: serve .md alongside .html\n# Hugo: place page.md in /static/ — built unchanged\n# Jekyll: drop page.md in /assets/ — copied as-is\n# Astro: src/pages/page.md.ts that exports a GET returning markdown\n\n# Then advertise with mechanism 3 in <head>:\n#   <link rel=\"alternate\" type=\"text/markdown\" href=\"/page.md\">"
        }
      ]
    }
  ]
}

使用我们的API以编程方式获取此内容（即将推出）