-
Notifications
You must be signed in to change notification settings - Fork 44
docs: add llms usage docs #1673
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
uniyalabhishek
merged 1 commit into
main
from
uniyalabhishek/feature/1665-llms-docs-mcp
Feb 23, 2026
+148
−0
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| --- | ||
| description: Use Oasis documentation with AI coding assistants via llms.txt or Context7 MCP | ||
| --- | ||
|
|
||
| # AI-Assisted Development | ||
|
|
||
| Oasis documentation is available in LLM-optimized formats so AI coding | ||
| assistants can reference accurate, up-to-date Oasis docs instead of relying on | ||
| training data. There are two approaches: feed raw `llms.txt` files directly, or | ||
| set up the [Context7] MCP server for persistent IDE integration. | ||
|
|
||
| ## llms.txt | ||
|
|
||
| The [llms.txt] standard provides a structured, Markdown-based summary of the | ||
| entire Oasis documentation site optimized for LLM consumption. | ||
|
|
||
| Two files are available: | ||
|
|
||
| | File | Description | | ||
| |----------------------------------------|------------------------------------------------------------| | ||
| | [`llms.txt`][llms.txt-file] | Curated index with page titles, descriptions, and URLs | | ||
| | [`llms-full.txt`][llms-full.txt-file] | Complete documentation content inlined into a single file | | ||
|
|
||
| ### Usage | ||
|
|
||
| Paste the URLs directly into any LLM chat or you can also add the URL as project | ||
| context in tools that support it (e.g. Cursor's `@docs` feature, or Claude/Codex | ||
| project knowledge, CLAUDE.md/AGENTS.md). | ||
|
|
||
| :::tip | ||
|
|
||
| Use `llms.txt` when you need a quick overview or are working within tight | ||
| context limits. Use `llms-full.txt` when you need the agent to have access to | ||
| the complete documentation. | ||
|
|
||
| ::: | ||
|
|
||
| ## Context7 MCP | ||
|
|
||
| [Context7] is an MCP server that indexes documentation and serves it on demand | ||
| to AI coding assistants. It supports [40+ clients][all-clients] including Claude | ||
| Code, Cursor, VS Code, and JetBrains. | ||
|
|
||
| The Oasis documentation is indexed and available at: | ||
|
|
||
| ``` | ||
| Library ID: llmstxt/oasis_io_llms_txt | ||
| ``` | ||
|
|
||
| :::info | ||
|
|
||
| Use the library ID `llmstxt/oasis_io_llms_txt` in your prompts to ensure you | ||
| get the complete Oasis documentation. Other Oasis-related libraries on Context7 | ||
| may be incomplete. | ||
|
|
||
| ::: | ||
|
|
||
| ### Claude Code | ||
|
|
||
| Add the Context7 MCP server: | ||
|
|
||
| ```shell | ||
| claude mcp add --transport http context7 https://mcp.context7.com/mcp | ||
| ``` | ||
|
|
||
| Verify the server is registered: | ||
|
|
||
| ```shell | ||
| claude mcp list | ||
| ``` | ||
|
|
||
| ### Cursor | ||
|
|
||
| Add the following to your `.cursor/mcp.json`: | ||
|
|
||
| ```json | ||
| { | ||
| "mcpServers": { | ||
| "context7": { | ||
| "url": "https://mcp.context7.com/mcp" | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Other Clients | ||
|
|
||
| Context7 supports 40+ clients including VS Code, JetBrains, Windsurf, Zed, | ||
| and more. See the [full client list][all-clients] for setup instructions | ||
| specific to your tool. | ||
|
|
||
| ### Example Prompts | ||
|
|
||
| Once the MCP server is configured, use prompts like: | ||
|
|
||
| ``` | ||
| Use context7 MCP to fetch Oasis Sapphire quickstart docs. | ||
| Use library ID: llmstxt/oasis_io_llms_txt | ||
| ``` | ||
|
|
||
| ``` | ||
| Using context7, show me how to implement encrypted events on Sapphire. | ||
| Use library ID: llmstxt/oasis_io_llms_txt | ||
| ``` | ||
|
|
||
| ### Auto-Invocation | ||
|
|
||
| To avoid specifying "use context7" in every prompt, add a rule to your agent's | ||
| configuration: | ||
|
|
||
| - **Claude Code:** Add to your project's `CLAUDE.md`: | ||
|
|
||
| ``` | ||
| Always use Context7 MCP with library ID llmstxt/oasis_io_llms_txt when you | ||
| need Oasis documentation. | ||
| ``` | ||
|
|
||
| - **Cursor:** Add to Settings → Rules for AI: | ||
|
|
||
| ``` | ||
| Always use Context7 MCP with library ID llmstxt/oasis_io_llms_txt when you | ||
| need Oasis documentation. | ||
| ``` | ||
|
|
||
| [Context7]: https://context7.com | ||
| [all-clients]: https://context7.com/docs/resources/all-clients | ||
| [llms.txt]: https://llmstxt.org | ||
| [llms.txt-file]: https://docs.oasis.io/llms.txt | ||
| [llms-full.txt-file]: https://docs.oasis.io/llms-full.txt |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.