Build with AI Assistants
Compass provides LLM-optimized documentation that AI coding assistants can fetch directly. These endpoints follow the llms.txt standard and are designed for AI consumption - concise, example-rich, and including all SDK field names and parameters.Most AI coding assistants like Cursor, Claude Code, and GitHub Copilot can automatically fetch and use these documentation URLs when you reference them in your project.
Documentation URLs
Point your AI assistant to these URLs:| URL | Description | Size |
|---|---|---|
| docs.compasslabs.ai/llms-full.txt | Complete documentation with all examples | ~60KB |
| docs.compasslabs.ai/llms.txt | Condensed version for smaller context windows | ~17KB |
Setup for AI Coding Assistants
- Cursor
- Claude Code
- Other Assistants
Add to your project’s
.cursor/rules or .cursorrules file:What’s Included
The LLM documentation covers:| Section | Description |
|---|---|
| SDK Setup | Installation for Python and TypeScript, environment configuration |
| Core Concepts | Product Accounts, gas sponsorship, embedded fees |
| API Endpoints | All V2 endpoints with parameters and responses |
| SDK Field Reference | Exact field names for both Python and TypeScript SDKs |
| Code Examples | Complete working examples for common workflows |
| Troubleshooting | Common errors and solutions |
Example Prompts
Once your AI assistant has access to the documentation, you can ask:- “Write a Python script to fetch the top 5 USDC vaults on Base by APY”
- “How do I implement gas sponsorship for deposits?”
- “Create a TypeScript function to check all my earn positions”
- “What’s the difference between earn_transfer and earn_manage?”