Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 1.94 KB

File metadata and controls

47 lines (33 loc) · 1.94 KB

Documentation Context for AI Agents

This file provides quick reference for AI agents about available documentation sources.

Available Documentation Sources

  1. MCP (Model Context Protocol)

  2. Documentation Site

  3. GitHub Repository

  4. Full .txt Dump

Local Documentation

After running bun run setup, the following local documentation will be available:

  • _docs/SDK_AI_AGENT_GUIDE.md - SDK AI Agent guide for bitbadgesjs-sdk
  • docs/METADATA_HOSTING.md - Comprehensive guide for hosting metadata externally (static, tracked in git)
  • docs/TRANSACTION_HANDLING.md - Complete guide for transaction handling, TxContext, simulation, and polling (static, tracked in git)
  • _docs/proto/ - Protocol buffer definitions
  • _docs/chain-registry/bitbadges/ - Chain registry information including:
    • chain.json - Chain configuration
    • _IBC/ - IBC connection information (filtered: bitbadges*.json only)
  • _docs/bitbadges-docs/ - Full documentation repository (only if DOWNLOAD_FULL_DOCS=true in .env)
    • token-standard/learn/ - ⚠️ REQUIRED READING: Token Standard Learn section

Quick Links