|
1 | | -# Use XMTP documentation with AI coding assistants |
| 1 | +import BuildWithLlms from '../../../snippets/build-with-llms.mdx'; |
2 | 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. |
| 3 | +<BuildWithLlms /> |
0 commit comments