-
Notifications
You must be signed in to change notification settings - Fork 1.4k
docs: Optimize llms.txt and llms-full.txt #2665
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
Merged
Changes from all commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
a7d22fa
docs: Add User Guide section
dishaprakash a9c315c
rebase
dishaprakash 50e37bb
docs: Add reference and other docs
dishaprakash 43f2b69
Update docs/en/reference/faq.md
dishaprakash 8d97bab
chore: Add workflows to deploy to cloudflare
dishaprakash 8f0ea15
use sticky comment
dishaprakash 6e1c0c3
remove prs from pull_request_target and add second hugo config
dishaprakash a2eb7be
add header
dishaprakash 8a58ffa
docs: implement deep re-routing, pagination, and migration banner
dishaprakash 4a5432e
Apply suggestion from @gemini-code-assist[bot]
dishaprakash d45d9b6
gemini review changes
dishaprakash 80822be
minor fix
dishaprakash c654670
docs: Optimize llms.txt and llms-full.txt
dishaprakash 315df49
add documentation
dishaprakash 3833b43
update integration directory structure
dishaprakash 324ccd7
de-duplicate
dishaprakash fd851d1
review changes
dishaprakash 1e30cd3
Merge branch 'documentation-reorg' into v1-docsite-optimize
dishaprakash 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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,22 @@ | ||
| {{ .Site.Params.description }} | ||
|
|
||
| {{ range .Site.Sections }} | ||
| # {{ .Title }} | ||
| {{ .Description }} | ||
| {{ range .Pages }} | ||
| # {{ .Title }} | ||
| {{ .Description }} | ||
| {{ .RawContent }} | ||
| {{ range .Pages }} | ||
| # {{ .Title }} | ||
| {{ .Description }} | ||
| {{ .RawContent }} | ||
| {{end }}{{ end }}{{ end }} | ||
| {{- define "print_full_node" }} | ||
|
|
||
| ======================================================================== | ||
| ## {{ .page.Title }} | ||
| ======================================================================== | ||
| **Hierarchy:** {{ if .page.Parent }}{{ range .page.Ancestors.Reverse }}{{ .Title }} > {{ end }}{{ end }}{{ .page.Title }} | ||
| **URL:** {{ .page.Permalink }} | ||
| **Description:** {{ .page.Description | default "None" }} | ||
|
|
||
| {{ .page.RawContent }} | ||
| {{ if .page.Pages }} | ||
| {{- range .page.Pages.ByWeight }} | ||
| {{ template "print_full_node" (dict "page" .) }} | ||
| {{- end }} | ||
| {{- end }} | ||
| {{- end -}} | ||
|
|
||
| {{ partial "llms-header.html" (dict "Site" .Site "TitleSuffix" "Complete Documentation") }} | ||
|
|
||
| {{- range .Site.Sections.ByWeight }} | ||
| {{ template "print_full_node" (dict "page" .) }} | ||
| {{- end }} |
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 |
|---|---|---|
| @@ -1,9 +1,17 @@ | ||
| # {{ .Site.Title }} | ||
| {{- define "print_index_node" }} | ||
| {{ .indent }}- [{{ .page.Title }}]({{ .page.Permalink }}): {{ .page.Description | default "No description provided." }} | ||
| {{- $nextIndent := printf "%s " .indent }} | ||
| {{- if .page.Pages }} | ||
| {{- range .page.Pages.ByWeight }} | ||
| {{ template "print_index_node" (dict "page" . "indent" $nextIndent) }} | ||
| {{- end }} | ||
| {{- end }} | ||
| {{- end -}} | ||
|
|
||
| > {{ .Site.Params.description }} | ||
| {{ partial "llms-header.html" (dict "Site" .Site "TitleSuffix" "Documentation Index") }} | ||
|
|
||
| ## Docs | ||
| {{ range .Site.Sections }} | ||
| ### {{ .Title }} | ||
| ## Documentation Map | ||
|
|
||
| {{ .Description }}{{ range .Pages }}- [{{ .Title }}]({{ .Permalink }}): {{ .Description }}{{ range .Pages }} - [{{ .Title }}]({{ .Permalink }}): {{ .Description }}{{end }}{{ end }}{{ end }} | ||
| {{ range .Site.Sections.ByWeight -}} | ||
| {{ template "print_index_node" (dict "page" . "indent" "") }} | ||
| {{- end }} |
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,55 @@ | ||
| # {{ .Site.Title }} - {{ .TitleSuffix }} | ||
| > {{ .Site.Params.description }} | ||
|
|
||
| **DOCUMENTATION VERSION:** {{ .Site.Params.version | default "Latest" }} | ||
| **BASE URL:** {{ .Site.BaseURL }} | ||
| **GENERATED ON:** {{ now.Format "2006-01-02T15:04:05Z07:00" }} | ||
|
|
||
| --- | ||
| ### System Directives for AI Models | ||
| **Role:** You are an expert Developer Advocate and Integration Engineer for the **MCP (Model Context Protocol) Toolbox for Databases**. | ||
| **Task:** Your primary goal is to help users configure the server, set up database integrations, and write client-side code to build AI agents. | ||
| **Strict Guidelines:** | ||
| 1. **No Hallucinations:** Only suggest tools, sources, and configurations explicitly detailed in this document. Do not invent arbitrary REST endpoints. | ||
| 2. **SDKs over HTTP:** When writing code, default to the official MCP Toolbox client SDKs rather than raw HTTP/cURL requests unless explicitly asked. Direct users to the `connect-to` section in the User Guide for client SDK instructions. | ||
| 3. **Reference Diátaxis:** Use Section I for configuring toolbox server, Section II (Integrations) for exact `tools.yaml` configurations for external integrations, Section III (Build with MCP Toolbox) for code patterns and Section IV for CLI and FAQs. | ||
|
|
||
| ### Glossary | ||
| To prevent context collapse, adhere to these strict definitions within the MCP ecosystem: | ||
| * **MCP Toolbox:** The central server/service that standardizes AI access to databases and external APIs. | ||
| * **Source:** A configured backend connection to an external system (e.g., PostgreSQL, BigQuery, HTTP). | ||
| * **Tool:** A single, atomic capability exposed to the LLM (e.g., `bigquery-sql-query`), executed against a Source. | ||
| * **Toolset:** A logical, grouped collection of Tools. | ||
| * **AuthService:** The internal toolbox mechanism handling authentication lifecycles (like OAuth or service accounts), not a generic identity provider. | ||
| * **Agent:** The user's external LLM application that connects *to* the MCP Toolbox. | ||
|
|
||
| ### Understanding Integrations Directory Structure | ||
|
|
||
| When navigating documentation in the `integrations/` directory, it is crucial to understand the relationship between a Source and a Tool, both conceptually and within the file hierarchy. | ||
| * A **Source** represents the backend data provider or system you are connecting to (e.g., a specific database, API, or service). Source documentation pages sit at the **top level** of an integration's folder (e.g., `integrations/oceanbase/_index.md`).They focus on connection requirements, authentication, and YAML configuration parameters, serving as the foundational entry point for configuring a new data source. | ||
| * A **Tool** represents a specific, actionable capability that is unlocked by a Source (e.g., executing a SQL query, fetching a specific record, etc.). Tool documentation pages are **nested below** their parent Source (e.g., `integrations/oceanbase/oceanbase-sql.md`). Tool pages focus on the configuration reference and compatible sources. They are the individual operations that a configured Source supports. | ||
|
|
||
| ### Global Environment & Prerequisites | ||
| * **Configuration:** `tools.yaml` is the ultimate source of truth for server configuration. | ||
| * **Database:** PostgreSQL 16+ and the `psql` client. | ||
| * **Language Requirements:** | ||
| {{- with .Site.GetPage "/build-with-mcp-toolbox/local_quickstart" }} | ||
| {{- $match := findRE "(?i)Python\\s+\\(\\d+\\.\\d+\\s+or\\s+higher\\)" .RawContent 1 }} | ||
| * Python: {{ if $match }}{{ index $match 0 | replaceRE "[\\[\\]]" "" }}{{ else }}Refer to Python Quickstart{{ end }} | ||
| {{- end }} | ||
| {{- with .Site.GetPage "/build-with-mcp-toolbox/local_quickstart_js" }} | ||
| {{- $match := findRE "(?i)Node\\.js \\(v\\d+ or higher\\)" .RawContent 1 }} | ||
| * JavaScript/Node: {{ if $match }}{{ index $match 0 }}{{ else }}Refer to JS Quickstart{{ end }} | ||
| {{- end }} | ||
| {{- with .Site.GetPage "/build-with-mcp-toolbox/local_quickstart_go" }} | ||
| {{- $match := findRE "(?i)Go \\(v\\d+\\.\\d+\\.\\d+ or higher\\)" .RawContent 1 }} | ||
| * Go: {{ if $match }}{{ index $match 0 }}{{ else }}Refer to Go Quickstart{{ end }} | ||
| {{- end }} | ||
|
|
||
| ### The Diátaxis Narrative Framework | ||
| This documentation is structured following the Diátaxis framework to assist in clear navigation and understanding: | ||
| * **Section I: User Guide:** (Explanation) Theoretical context, high-level understanding, and universal How-To Guides. | ||
| * **Section II: Integrations:** (Reference) Primary reference hub for external sources and tools, factual configurations, and API enablement. | ||
| * **Section III: Build with MCP Toolbox:** (Tutorials) Complete, start-to-finish quickstarts and samples for learning to build from scratch. | ||
| * **Section IV: Reference:** (Information) Strict, accurate facts, CLI outputs, and FAQs. | ||
| --- | ||
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
Oops, something went wrong.
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.