Skip to content

Commit 00fe5cc

Browse files
authored
llms doc for agents (#661)
1 parent 0dfea1b commit 00fe5cc

File tree

6 files changed

+60
-49
lines changed

6 files changed

+60
-49
lines changed

docs/pages/agents/get-started/build-an-agent.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -117,11 +117,12 @@ XMTP creates local database files in the `dbPath` (default is `'./'`) directory.
117117

118118
## Vibe coding
119119

120-
See these [Cursor rules](https://github.com/xmtplabs/xmtp-agent-examples/blob/main/.cursor/rules/xmtp.mdc) for vibe coding agents with XMTP using best practices.
120+
To make it easier for you to build with XMTP using LLMs and coding assistants, we offer two AI-ready solutions:
121121

122-
```bash
123-
Prompt: lets create an example that gets a number and returns its 2x multiple (use claude max)
124-
```
122+
- A docs MCP server
123+
- Use case-based llms.txt files
124+
125+
To learn more, see [Use XMTP documentation with AI coding assistants](/agents/get-started/build-with-llms).
125126

126127
## Talk to your agent
127128

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import BuildWithLlms from '../../../snippets/build-with-llms.mdx';
2+
3+
<BuildWithLlms />
Lines changed: 2 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,3 @@
1-
# Use XMTP documentation with AI coding assistants
1+
import BuildWithLlms from '../../../snippets/build-with-llms.mdx';
22

3-
To make it easier for you to build with XMTP using LLMs and coding assistants, we offer two AI-ready solutions. Choose the one that best fits your workflow:
4-
5-
**Use the [documentation MCP (Model Context Protocol) server](#documentation-mcp-server) if:**
6-
- You're using MCP-compatible tools like Claude Code, Cursor, or Copilot for example
7-
- You want dynamic, structured documentation querying while writing and debugging code
8-
- You're comfortable setting up and running a local server process
9-
10-
**Use [llms.txt files](#llmstxt-files) if:**
11-
- You're using AI tools that don't support MCP
12-
- You want zero-setup access to documentation
13-
- You prefer a simple copy-paste or URL reference approach
14-
15-
## Documentation MCP server
16-
17-
You can run a local XMTP documentation MCP server that you can use with Claude Code, Cursor, Copilot, and other MCP-compatible AI coding assistants.
18-
19-
To learn about how it's built and how to use it, see the [xmtp-docs-mcp repo](https://github.com/xmtp/xmtp-docs-mcp).
20-
21-
## llms.txt files
22-
23-
If you're using an AI coding assistant that allows custom context, you can upload or point to the appropriate file to enhance your development experience with XMTP. Using the file focused on your builder use case (chat apps or agents) typically provides better AI performance by narrowing the context.
24-
25-
### For building chat apps
26-
27-
Use `llms-chat-apps.txt`: [https://raw.githubusercontent.com/xmtp/docs-xmtp-org/main/llms/llms-chat-apps.txt](https://raw.githubusercontent.com/xmtp/docs-xmtp-org/main/llms/llms-chat-apps.txt)
28-
29-
Includes: Core messaging, content types, push notifications, user consent, protocol fundamentals, network operations, and funding information.
30-
31-
### For building agents
32-
33-
Use `llms-agents.txt`: [https://raw.githubusercontent.com/xmtp/docs-xmtp-org/main/llms/llms-agents.txt](https://raw.githubusercontent.com/xmtp/docs-xmtp-org/main/llms/llms-agents.txt)
34-
35-
Includes: Agent concepts, building and deploying agents, agent-specific content types, protocol fundamentals, network operations, and funding information.
36-
37-
### For comprehensive coverage
38-
39-
Use `llms-full.txt`: [https://raw.githubusercontent.com/xmtp/docs-xmtp-org/main/llms/llms-full.txt](https://raw.githubusercontent.com/xmtp/docs-xmtp-org/main/llms/llms-full.txt)
40-
41-
Includes: All documentation for chat apps, agents, protocol fundamentals, network operations, and funding information.
3+
<BuildWithLlms />

docs/pages/chat-apps/intro/get-started.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,11 @@ To learn more, see [Why build with XMTP?](/chat-apps/intro/why-xmtp).
1818
<SdkButton href="/chat-apps/sdks/ios">iOS</SdkButton>
1919
</SdkButtons>
2020

21-
- [Use llms-full.txt](/chat-apps/intro/build-with-llms) to provide the full text of the XMTP developer documentation to an AI coding assistant.
21+
- To make it easier for you to build with XMTP using LLMs and coding assistants, we offer two AI-ready solutions:
22+
- A docs MCP server
23+
- Use case-based llms.txt files
24+
25+
To learn more, see [Use XMTP documentation with AI coding assistants](/chat-apps/intro/build-with-llms).
2226

2327
- [Use xmtp.chat](https://xmtp.chat), the official web chat app for developers, to interact with and test your app
2428

docs/snippets/build-with-llms.mdx

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Use XMTP documentation with AI coding assistants
2+
3+
To make it easier for you to build with XMTP using LLMs and coding assistants, we offer two AI-ready solutions. Choose the one that best fits your workflow:
4+
5+
**Use the [documentation MCP (Model Context Protocol) server](#documentation-mcp-server) if:**
6+
- You're using MCP-compatible tools like Claude Code, Cursor, or Copilot for example
7+
- You want dynamic, structured documentation querying while writing and debugging code
8+
- You're comfortable setting up and running a local server process
9+
10+
**Use [llms.txt files](#llmstxt-files) if:**
11+
- You're using AI tools that don't support MCP
12+
- You want zero-setup access to documentation
13+
- You prefer a simple copy-paste or URL reference approach
14+
15+
## Documentation MCP server
16+
17+
You can run a local XMTP documentation MCP server that you can use with Claude Code, Cursor, Copilot, and other MCP-compatible AI coding assistants.
18+
19+
To learn about how it's built and how to use it, see the [xmtp-docs-mcp repo](https://github.com/xmtp/xmtp-docs-mcp).
20+
21+
## llms.txt files
22+
23+
If you're using an AI coding assistant that allows custom context, you can upload or point to the appropriate file to enhance your development experience with XMTP. Using the file focused on your builder use case (chat apps or agents) typically provides better AI performance by narrowing the context.
24+
25+
### For building chat apps
26+
27+
Use `llms-chat-apps.txt`: [https://raw.githubusercontent.com/xmtp/docs-xmtp-org/main/llms/llms-chat-apps.txt](https://raw.githubusercontent.com/xmtp/docs-xmtp-org/main/llms/llms-chat-apps.txt)
28+
29+
Includes: Core messaging, content types, push notifications, user consent, protocol fundamentals, network operations, and funding information.
30+
31+
### For building agents
32+
33+
Use `llms-agents.txt`: [https://raw.githubusercontent.com/xmtp/docs-xmtp-org/main/llms/llms-agents.txt](https://raw.githubusercontent.com/xmtp/docs-xmtp-org/main/llms/llms-agents.txt)
34+
35+
Includes: Agent concepts, building and deploying agents, agent-specific content types, protocol fundamentals, network operations, and funding information.
36+
37+
### For comprehensive coverage
38+
39+
Use `llms-full.txt`: [https://raw.githubusercontent.com/xmtp/docs-xmtp-org/main/llms/llms-full.txt](https://raw.githubusercontent.com/xmtp/docs-xmtp-org/main/llms/llms-full.txt)
40+
41+
Includes: All documentation for chat apps, agents, protocol fundamentals, network operations, and funding information.

shared-sidebar.config.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ export const sidebarConfig = {
1616
link: "/agents/get-started/build-an-agent",
1717
},
1818
{
19-
text: "FAQ",
20-
link: "/agents/get-started/faq",
19+
text: "Build with LLMs",
20+
link: "/agents/get-started/build-with-llms",
2121
},
2222
{
23-
text: "Cursor rules",
24-
link: "https://github.com/xmtplabs/xmtp-agent-examples/blob/main/.cursor/rules/xmtp.mdc",
23+
text: "FAQ",
24+
link: "/agents/get-started/faq",
2525
},
2626
{ text: 'Join the XMTP Dev Community',
2727
link: 'https://forms.gle/hesZ55WGMjJnZ7sQA',

0 commit comments

Comments
 (0)