1# Remote Docs Reference
2 
3How to look up current documentation from https://mastra.ai when local packages aren't available or you need conceptual guidance.
4 
5**Use this when:**
6 
7- Mastra packages aren't installed locally
8- You need conceptual explanations or guides
9- You want the latest documentation (may be ahead of installed version)
10 
11## Documentation site structure
12 
13Mastra docs are organized at **https://mastra.ai**:
14 
15- **Docs**: Core documentation covering concepts, features, and implementation details
16- **Models**: Mastra provides a unified interface for working with LLMs across multiple providers
17- **Guides**: Step-by-step tutorials for building specific applications
18- **Reference**: API reference documentation
19 
20## Finding relevant documentation
21 
22### Method 1: Use llms.txt (Recommended)
23 
24The main llms.txt file provides an agent-friendly overview of all documentation: https://mastra.ai/llms.txt
25 
26This returns a structured markdown document with:
27 
28- Documentation organization and hierarchy
29- All available topics and sections
30- Direct links to relevant documentation
31- Agent-optimized content structure
32 
33**Use this first** to understand what documentation is available and where to find specific topics.
34 
35### Method 2: Direct URL patterns
36 
37Documentation follows predictable URL patterns:
38 
39- Overview pages: `https://mastra.ai/docs/{topic}/overview`
40- API reference: `https://mastra.ai/reference/{topic}/`
41- Guides: `https://mastra.ai/guides/{topic}/`
42 
43**Examples:**
44 
45- `https://mastra.ai/docs/agents/overview`
46- `https://mastra.ai/docs/workflows/overview`
47- `https://mastra.ai/reference/workflows/workflow-methods/`
48 
49## Agent-friendly documentation
50 
51**Critical feature**: Send the `text-markdown` request header or add `.md` to any documentation URL to get clean, agent-friendly markdown.
52 
53### Standard URL:
54 
55```
56https://mastra.ai/reference/workflows/workflow-methods/then
57```
58 
59### Agent-friendly URL (Markdown):
60 
61```
62https://mastra.ai/reference/workflows/workflow-methods/then.md
63```
64 
65The `.md` version:
66 
67- Removes navigation, headers, footers
68- Returns pure markdown content
69- Optimized for LLM consumption
70- Includes all code examples and explanations
71 
72## Lookup Workflow
73 
74### 1. Check the main documentation index
75 
76**Start here** to understand what's available:
77 
78```
79https://mastra.ai/llms.txt
80```
81 
82This provides:
83 
84- Complete documentation structure
85- Available topics and sections
86- Links to relevant documentation pages
87 
88### 2. Find relevant documentation
89 
90**Option A: Use information from llms.txt**
91The main llms.txt will guide you to the right section.
92 
93**Option B: Construct URL directly**
94 
95```
96https://mastra.ai/docs/{topic}/overview
97https://mastra.ai/reference/{topic}/
98```
99 
100### 3. Fetch agent-friendly version
101 
102Add `.md` to the end of any documentation URL:
103 
104```
105https://mastra.ai/reference/workflows/workflow-methods/then.md
106```
107 
108### 4. Extract relevant information
109 
110The markdown will include:
111 
112- Function signatures
113- Parameter descriptions
114- Return types
115- Usage examples
116- Best practices
117 
118## Common documentation paths
119 
120### Agents
121 
122- Overview: `https://mastra.ai/docs/agents/overview`
123- Creating agents: `https://mastra.ai/docs/agents/creating-agents`
124- Agent tools: `https://mastra.ai/docs/agents/tools`
125- Memory: `https://mastra.ai/docs/agents/memory`
126 
127### Workflows
128 
129- Overview: `https://mastra.ai/docs/workflows/overview`
130- Creating workflows: `https://mastra.ai/docs/workflows/creating-workflows`
131- Workflow methods: `https://mastra.ai/reference/workflows/workflow-methods/`
132 
133### Tools
134 
135- Overview: `https://mastra.ai/docs/tools/overview`
136- Creating tools: `https://mastra.ai/docs/tools/creating-tools`
137 
138### Memory
139 
140- Overview: `https://mastra.ai/docs/memory/overview`
141- Configuration: `https://mastra.ai/docs/memory/configuration`
142 
143### RAG
144 
145- Overview: `https://mastra.ai/docs/rag/overview`
146- Vector stores: `https://mastra.ai/docs/rag/vector-stores`
147 
148## Example: Looking up workflow .then() method
149 
150### 1. Check main documentation index
151 
152```
153WebFetch({
154  url: "https://mastra.ai/llms.txt",
155  prompt: "Where can I find documentation about workflow methods like .then()?"
156})
157```
158 
159This will point you to the workflows reference section.
160 
161### 2. Fetch specific method documentation
162 
163```
164https://mastra.ai/reference/workflows/workflow-methods/then.md
165```
166 
167### 3. Use WebFetch tool
168 
169```
170WebFetch({
171  url: "https://mastra.ai/reference/workflows/workflow-methods/then.md",
172  prompt: "What are the parameters for the .then() method and how do I use it?"
173})
174```
175 
176## When to use remote vs embedded docs
177 
178| Situation                  | Use                                                 |
179| -------------------------- | --------------------------------------------------- |
180| Packages installed locally | **Embedded docs** (guaranteed version match)        |
181| Packages not installed     | **Remote docs**                                     |
182| Need conceptual guides     | **Remote docs**                                     |
183| Need exact API signatures  | **Embedded docs** (if available)                    |
184| Exploring new features     | **Remote docs** (may be ahead of installed version) |
185| Need working examples      | **Both** (embedded for types, remote for guides)    |
186 
187## Best practices
188 
1891. **Always use .md** for fetching documentation
1902. **Check sitemap.xml** when unsure about URL structure
1913. **Prefer embedded docs** when packages are installed (version accuracy)
1924. **Use remote docs** for conceptual understanding and guides
1935. **Combine both** for comprehensive understanding
194