diff --git a/.ci/sample_tests/pre_post_processing/go.integration.cloudbuild.yaml b/.ci/sample_tests/pre_post_processing/go.integration.cloudbuild.yaml index c6efdddde1c8..08e6be8f9acd 100644 --- a/.ci/sample_tests/pre_post_processing/go.integration.cloudbuild.yaml +++ b/.ci/sample_tests/pre_post_processing/go.integration.cloudbuild.yaml @@ -48,7 +48,7 @@ timeout: 1200s substitutions: _TARGET_LANG: "go" _IMAGE: "golang:1.25.1" - _TARGET_ROOT: "docs/en/user-guide/configuration/pre-post-processing/go" + _TARGET_ROOT: "docs/en/build-with-mcp-toolbox/pre-post-processing/go" _TABLE_NAME: "hotels_go_pre_post_processing" _SQL_FILE: ".ci/sample_tests/setup_hotels.sql" _AGENT_FILE_PATTERN: "agent.go" diff --git a/.ci/sample_tests/pre_post_processing/js.integration.cloudbuild.yaml b/.ci/sample_tests/pre_post_processing/js.integration.cloudbuild.yaml index fb9ded3fe37d..59de72f06136 100644 --- a/.ci/sample_tests/pre_post_processing/js.integration.cloudbuild.yaml +++ b/.ci/sample_tests/pre_post_processing/js.integration.cloudbuild.yaml @@ -48,7 +48,7 @@ timeout: 1200s substitutions: _TARGET_LANG: "js" _IMAGE: "node:22" - _TARGET_ROOT: "docs/en/user-guide/configuration/pre-post-processing/js" + _TARGET_ROOT: "docs/en/build-with-mcp-toolbox/pre-post-processing/js" _TABLE_NAME: "hotels_js_pre_post_processing" _SQL_FILE: ".ci/sample_tests/setup_hotels.sql" _AGENT_FILE_PATTERN: "agent.js" diff --git a/.ci/sample_tests/pre_post_processing/py.integration.cloudbuild.yaml b/.ci/sample_tests/pre_post_processing/py.integration.cloudbuild.yaml index 0bd0831ba181..82fcc2d056ca 100644 --- a/.ci/sample_tests/pre_post_processing/py.integration.cloudbuild.yaml +++ b/.ci/sample_tests/pre_post_processing/py.integration.cloudbuild.yaml @@ -48,7 +48,7 @@ timeout: 1200s substitutions: _TARGET_LANG: "python" _IMAGE: "gcr.io/google.com/cloudsdktool/cloud-sdk:537.0.0" - _TARGET_ROOT: "docs/en/user-guide/configuration/pre-post-processing/python" + _TARGET_ROOT: "docs/en/build-with-mcp-toolbox/pre-post-processing/python" _TABLE_NAME: "hotels_py_pre_post_processing" _SQL_FILE: ".ci/sample_tests/setup_hotels.sql" _AGENT_FILE_PATTERN: "agent.py" diff --git a/.github/header-checker-lint.yml b/.github/header-checker-lint.yml index b9add979ad62..55b4ced68a23 100644 --- a/.github/header-checker-lint.yml +++ b/.github/header-checker-lint.yml @@ -23,4 +23,5 @@ sourceFileExtensions: - 'yml' ignoreFiles: - 'docs/en/build-with-mcp-toolbox/**' + - 'docs/en/build-with-mcp-toolbox/**/*' - '**/*oracle*' \ No newline at end of file diff --git a/.github/workflows/deploy_dev_docs_to_cf.yaml b/.github/workflows/deploy_dev_docs_to_cf.yaml index 02758f349849..ac2b143d6abc 100644 --- a/.github/workflows/deploy_dev_docs_to_cf.yaml +++ b/.github/workflows/deploy_dev_docs_to_cf.yaml @@ -71,6 +71,9 @@ jobs: HUGO_BASEURL: https://mcp-toolbox.dev/dev/ HUGO_RELATIVEURLS: false + - name: Build Pagefind Search Index + run: npx pagefind --site public + - name: Create Staging Directory run: | mkdir staging diff --git a/.github/workflows/deploy_previous_version_docs_to_cf.yaml b/.github/workflows/deploy_previous_version_docs_to_cf.yaml index 35b344c942a6..bbe68755cdd4 100644 --- a/.github/workflows/deploy_previous_version_docs_to_cf.yaml +++ b/.github/workflows/deploy_previous_version_docs_to_cf.yaml @@ -73,7 +73,7 @@ jobs: HUGO_RELATIVEURLS: false HUGO_PARAMS_VERSION: ${{ github.event.inputs.version_tag }} - - name: Build Pagefind Index (Root) + - name: Build Pagefind Index (Archived Version) run: npx pagefind --site public working-directory: .hugo diff --git a/.github/workflows/deploy_versioned_docs_to_cf.yaml b/.github/workflows/deploy_versioned_docs_to_cf.yaml index cfac34d98c9c..a044c6c74dea 100644 --- a/.github/workflows/deploy_versioned_docs_to_cf.yaml +++ b/.github/workflows/deploy_versioned_docs_to_cf.yaml @@ -63,7 +63,7 @@ jobs: HUGO_RELATIVEURLS: false HUGO_PARAMS_VERSION: ${{ steps.get_version.outputs.VERSION }} - - name: Build Pagefind Index (Root) + - name: Build Pagefind Index (Versioned) run: npx pagefind --site public working-directory: .hugo diff --git a/.github/workflows/docs_lint.yaml b/.github/workflows/docs_lint.yaml index ed8387102bf2..1e926b53697b 100644 --- a/.github/workflows/docs_lint.yaml +++ b/.github/workflows/docs_lint.yaml @@ -18,6 +18,7 @@ on: pull_request: paths: - 'docs/**' + - '.github/workflows/docs**' - '.ci/lint-docs-*.sh' jobs: diff --git a/.github/workflows/docs_preview_build_cf.yaml b/.github/workflows/docs_preview_build_cf.yaml new file mode 100644 index 000000000000..e1f4d67e9440 --- /dev/null +++ b/.github/workflows/docs_preview_build_cf.yaml @@ -0,0 +1,89 @@ +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +name: "CF: Build Docs Preview" + +on: + pull_request: + paths: + - 'docs/**' + - '.github/workflows/docs*_cf.yaml' + - '.hugo/**' + +permissions: read-all + +jobs: + build-preview: + runs-on: ubuntu-24.04 + env: + PR_NUMBER: ${{ github.event.number }} + HEAD_SHA: ${{ github.event.pull_request.head.sha }} + concurrency: + group: "cf-preview-${{ github.event.number }}" + cancel-in-progress: true + defaults: + run: + working-directory: .hugo + steps: + - uses: actions/checkout@v4 + with: + ref: ${{ env.HEAD_SHA }} + fetch-depth: 0 + + - name: Setup Hugo + uses: peaceiris/actions-hugo@v3 + with: + hugo-version: "0.145.0" + extended: true + + - name: Setup Node + uses: actions/setup-node@v4 + with: + node-version: "22" + cache: 'npm' + cache-dependency-path: '.hugo/package-lock.json' + + - run: npm ci --ignore-scripts + - run: hugo --minify --config hugo.cloudflare.toml + env: + HUGO_BASEURL: "/" + HUGO_ENVIRONMENT: preview + HUGO_RELATIVEURLS: false + + - name: Build Pagefind Search Index + run: npx pagefind --site public + + - name: Prepare Artifact Payload + run: | + mkdir -p ../artifact-payload + cp -r public ../artifact-payload/public + echo ${{ env.PR_NUMBER }} > ../artifact-payload/pr_number.txt + + - name: Upload Artifact + uses: actions/upload-artifact@v4 + with: + name: cf-preview-data + path: artifact-payload/ + retention-days: 1 + + - name: Deployment Link + run: | + DEPLOY_URL="https://github.com/${{ github.repository_owner }}/${{ github.event.repository.name }}/actions/workflows/docs_deploy_cf.yaml" + + echo "### Build Complete" >> $GITHUB_STEP_SUMMARY + echo "The build for PR #${{ env.PR_NUMBER }} succeeded." >> $GITHUB_STEP_SUMMARY + echo "The Cloudflare deployment workflow is now starting." >> $GITHUB_STEP_SUMMARY + echo "---" >> $GITHUB_STEP_SUMMARY + echo "#### [Track Deployment Progress]($DEPLOY_URL)" >> $GITHUB_STEP_SUMMARY \ No newline at end of file diff --git a/.github/workflows/docs_preview_deploy_cf.yaml b/.github/workflows/docs_preview_deploy_cf.yaml index b1cc19e3b5b0..63e7c7040eee 100644 --- a/.github/workflows/docs_preview_deploy_cf.yaml +++ b/.github/workflows/docs_preview_deploy_cf.yaml @@ -12,84 +12,77 @@ # See the License for the specific language governing permissions and # limitations under the License. -name: "CF: Deploy PR Preview" +name: "CF: Deploy Docs Preview" + +on: + workflow_run: + workflows: ["CF: Build Docs Preview"] + types: + - completed + workflow_dispatch: + inputs: + pr_number: + description: 'PR Number to deploy (Manual override)' + required: true + type: string + build_run_id: + description: 'The Run ID from the successful "CF: Build Docs Preview" workflow' + required: true + type: string permissions: contents: read pull-requests: write -# This Workflow depends on 'github.event.number', -# not compatible with branch or manual triggers. -on: - pull_request: - paths: - - 'docs/**' - - '.github/workflows/docs*_cf.yaml' - - '.github/workflows/deploy*_cf.yaml' - - '.hugo/**' - jobs: - preview: - # Only run for PRs from the same repository to ensure secret access - if: "${{ github.event.pull_request.head.repo.full_name == github.event.pull_request.base.repo.full_name }}" + deploy-preview: + if: > + github.event_name == 'workflow_dispatch' || + (github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success') runs-on: ubuntu-24.04 - defaults: - run: - working-directory: .hugo concurrency: - # Shared concurrency group with preview cleanup. - group: "cf-preview-${{ github.event.number }}" + group: "cf-deploy-${{ github.event.inputs.pr_number || github.event.workflow_run.pull_requests[0].number }}" cancel-in-progress: true steps: - - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6 - with: - ref: ${{ github.event.pull_request.head.sha }} - fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod + - name: Checkout base repository + uses: actions/checkout@v4 - - name: Setup Hugo - uses: peaceiris/actions-hugo@75d2e84710de30f6ff7268e08f310b60ef14033f # v3 + - name: Download Artifact + uses: actions/download-artifact@v4 with: - hugo-version: "0.145.0" - extended: true + name: cf-preview-data + github-token: ${{ secrets.GITHUB_TOKEN }} + run-id: ${{ github.event.inputs.build_run_id || github.event.workflow_run.id }} + path: downloaded-artifact - - name: Setup Node - uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6 - with: - node-version: "22" + - name: Read PR Number + id: get_pr + run: | + if [ -n "${{ github.event.inputs.pr_number }}" ]; then + PR_NUMBER="${{ github.event.inputs.pr_number }}" + else + PR_NUMBER=$(cat downloaded-artifact/pr_number.txt) + fi + echo "pr_number=$PR_NUMBER" >> "$GITHUB_OUTPUT" - - name: Cache dependencies - uses: actions/cache@cdf6c1fa76f9f475f3d7449005a359c84ca0f306 # v5 - with: - path: ~/.npm - key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} - restore-keys: | - ${{ runner.os }}-node- - - - run: npm ci - - run: hugo --minify --config hugo.cloudflare.toml - env: - HUGO_BASEURL: "/" - HUGO_ENVIRONMENT: preview - HUGO_RELATIVEURLS: false - - - name: Build Pagefind Search Index - run: npx pagefind --site public - - - name: Deploy to Cloudflare Pages via Wrangler + - name: Deploy to Cloudflare Pages id: cf_deploy uses: cloudflare/wrangler-action@v3 with: apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }} accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }} - command: pages deploy .hugo/public --project-name toolbox-docs --branch pr-${{ github.event.number }} + command: pages deploy downloaded-artifact/public --project-name toolbox-docs --branch pr-${{ steps.get_pr.outputs.pr_number }} - name: Comment uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8 with: script: | - github.rest.issues.createComment({ - issue_number: context.payload.number, + const prNumber = parseInt('${{ steps.get_pr.outputs.pr_number }}', 10); + const deployUrl = '${{ steps.cf_deploy.outputs.pages-deployment-alias-url }}'; + + await github.rest.issues.createComment({ + issue_number: prNumber, owner: context.repo.owner, repo: context.repo.repo, - body: "šŸš€ **Cloudflare Preview is building!**\n\nšŸ”Ž View Preview: ${{ steps.cf_deploy.outputs.pages-deployment-alias-url }}\n\n*(Note: It may take a minute or two for Cloudflare to finish deploying the branch)*" - }) + body: `šŸš€ **Cloudflare Preview Ready!**\n\nšŸ”Ž View Preview: ${deployUrl}\n\n*(Note: It may take a minute or two for Cloudflare to finish deploying the branch)*` + }); diff --git a/docs/en/blogs/_index.md b/docs/en/blogs/_index.md index 6a0ea5a42b72..fd303d7f4bb6 100644 --- a/docs/en/blogs/_index.md +++ b/docs/en/blogs/_index.md @@ -1,5 +1,6 @@ --- title: "Featured Articles" +icon: "fas fa-newspaper" weight: 1 description: Toolbox Medium Blogs manualLink: "https://medium.com/@mcp_toolbox" diff --git a/docs/en/user-guide/configuration/pre-post-processing/_index.md b/docs/en/build-with-mcp-toolbox/pre-post-processing/_index.md similarity index 100% rename from docs/en/user-guide/configuration/pre-post-processing/_index.md rename to docs/en/build-with-mcp-toolbox/pre-post-processing/_index.md diff --git a/docs/en/user-guide/configuration/pre-post-processing/go.md b/docs/en/build-with-mcp-toolbox/pre-post-processing/go.md similarity index 92% rename from docs/en/user-guide/configuration/pre-post-processing/go.md rename to docs/en/build-with-mcp-toolbox/pre-post-processing/go.md index 09f1a90721f4..4f2dec98ebd1 100644 --- a/docs/en/user-guide/configuration/pre-post-processing/go.md +++ b/docs/en/build-with-mcp-toolbox/pre-post-processing/go.md @@ -8,7 +8,7 @@ description: > ## Prerequisites -This tutorial assumes that you have set up MCP Toolbox with a basic agent as described in the [local quickstart](../../../build-with-mcp-toolbox/local_quickstart_go.md). +This tutorial assumes that you have set up MCP Toolbox with a basic agent as described in the [local quickstart](../../build-with-mcp-toolbox/local_quickstart_go.md). This guide demonstrates how to implement these patterns in your Toolbox applications. diff --git a/docs/en/user-guide/configuration/pre-post-processing/go/adk/agent.go b/docs/en/build-with-mcp-toolbox/pre-post-processing/go/adk/agent.go similarity index 100% rename from docs/en/user-guide/configuration/pre-post-processing/go/adk/agent.go rename to docs/en/build-with-mcp-toolbox/pre-post-processing/go/adk/agent.go diff --git a/docs/en/user-guide/configuration/pre-post-processing/go/adk/go.mod b/docs/en/build-with-mcp-toolbox/pre-post-processing/go/adk/go.mod similarity index 100% rename from docs/en/user-guide/configuration/pre-post-processing/go/adk/go.mod rename to docs/en/build-with-mcp-toolbox/pre-post-processing/go/adk/go.mod diff --git a/docs/en/user-guide/configuration/pre-post-processing/go/adk/go.sum b/docs/en/build-with-mcp-toolbox/pre-post-processing/go/adk/go.sum similarity index 100% rename from docs/en/user-guide/configuration/pre-post-processing/go/adk/go.sum rename to docs/en/build-with-mcp-toolbox/pre-post-processing/go/adk/go.sum diff --git a/docs/en/user-guide/configuration/pre-post-processing/go/agent_test.go b/docs/en/build-with-mcp-toolbox/pre-post-processing/go/agent_test.go similarity index 100% rename from docs/en/user-guide/configuration/pre-post-processing/go/agent_test.go rename to docs/en/build-with-mcp-toolbox/pre-post-processing/go/agent_test.go diff --git a/docs/en/user-guide/configuration/pre-post-processing/js.md b/docs/en/build-with-mcp-toolbox/pre-post-processing/js.md similarity index 94% rename from docs/en/user-guide/configuration/pre-post-processing/js.md rename to docs/en/build-with-mcp-toolbox/pre-post-processing/js.md index 3ce1f67c87cf..f19b8a171efa 100644 --- a/docs/en/user-guide/configuration/pre-post-processing/js.md +++ b/docs/en/build-with-mcp-toolbox/pre-post-processing/js.md @@ -8,7 +8,7 @@ description: > ## Prerequisites -This tutorial assumes that you have set up MCP Toolbox with a basic agent as described in the [local quickstart](../../../build-with-mcp-toolbox/local_quickstart_js.md). +This tutorial assumes that you have set up MCP Toolbox with a basic agent as described in the [local quickstart](../../build-with-mcp-toolbox/local_quickstart_js.md). This guide demonstrates how to implement these patterns in your Toolbox applications. diff --git a/docs/en/user-guide/configuration/pre-post-processing/js/adk/agent.js b/docs/en/build-with-mcp-toolbox/pre-post-processing/js/adk/agent.js similarity index 100% rename from docs/en/user-guide/configuration/pre-post-processing/js/adk/agent.js rename to docs/en/build-with-mcp-toolbox/pre-post-processing/js/adk/agent.js diff --git a/docs/en/user-guide/configuration/pre-post-processing/js/adk/package-lock.json b/docs/en/build-with-mcp-toolbox/pre-post-processing/js/adk/package-lock.json similarity index 100% rename from docs/en/user-guide/configuration/pre-post-processing/js/adk/package-lock.json rename to docs/en/build-with-mcp-toolbox/pre-post-processing/js/adk/package-lock.json diff --git a/docs/en/user-guide/configuration/pre-post-processing/js/adk/package.json b/docs/en/build-with-mcp-toolbox/pre-post-processing/js/adk/package.json similarity index 100% rename from docs/en/user-guide/configuration/pre-post-processing/js/adk/package.json rename to docs/en/build-with-mcp-toolbox/pre-post-processing/js/adk/package.json diff --git a/docs/en/user-guide/configuration/pre-post-processing/js/agent.test.js b/docs/en/build-with-mcp-toolbox/pre-post-processing/js/agent.test.js similarity index 100% rename from docs/en/user-guide/configuration/pre-post-processing/js/agent.test.js rename to docs/en/build-with-mcp-toolbox/pre-post-processing/js/agent.test.js diff --git a/docs/en/user-guide/configuration/pre-post-processing/js/langchain/agent.js b/docs/en/build-with-mcp-toolbox/pre-post-processing/js/langchain/agent.js similarity index 100% rename from docs/en/user-guide/configuration/pre-post-processing/js/langchain/agent.js rename to docs/en/build-with-mcp-toolbox/pre-post-processing/js/langchain/agent.js diff --git a/docs/en/user-guide/configuration/pre-post-processing/js/langchain/package-lock.json b/docs/en/build-with-mcp-toolbox/pre-post-processing/js/langchain/package-lock.json similarity index 100% rename from docs/en/user-guide/configuration/pre-post-processing/js/langchain/package-lock.json rename to docs/en/build-with-mcp-toolbox/pre-post-processing/js/langchain/package-lock.json diff --git a/docs/en/user-guide/configuration/pre-post-processing/js/langchain/package.json b/docs/en/build-with-mcp-toolbox/pre-post-processing/js/langchain/package.json similarity index 100% rename from docs/en/user-guide/configuration/pre-post-processing/js/langchain/package.json rename to docs/en/build-with-mcp-toolbox/pre-post-processing/js/langchain/package.json diff --git a/docs/en/user-guide/configuration/pre-post-processing/python.md b/docs/en/build-with-mcp-toolbox/pre-post-processing/python.md similarity index 94% rename from docs/en/user-guide/configuration/pre-post-processing/python.md rename to docs/en/build-with-mcp-toolbox/pre-post-processing/python.md index 0b83d54aefb4..621ec197d36a 100644 --- a/docs/en/user-guide/configuration/pre-post-processing/python.md +++ b/docs/en/build-with-mcp-toolbox/pre-post-processing/python.md @@ -8,7 +8,7 @@ description: > ## Prerequisites -This tutorial assumes that you have set up MCP Toolbox with a basic agent as described in the [local quickstart](../../../build-with-mcp-toolbox/local_quickstart.md). +This tutorial assumes that you have set up MCP Toolbox with a basic agent as described in the [local quickstart](../../build-with-mcp-toolbox/local_quickstart.md). This guide demonstrates how to implement these patterns in your Toolbox applications. diff --git a/docs/en/user-guide/configuration/pre-post-processing/python/__init__.py b/docs/en/build-with-mcp-toolbox/pre-post-processing/python/__init__.py similarity index 100% rename from docs/en/user-guide/configuration/pre-post-processing/python/__init__.py rename to docs/en/build-with-mcp-toolbox/pre-post-processing/python/__init__.py diff --git a/docs/en/user-guide/configuration/pre-post-processing/python/adk/agent.py b/docs/en/build-with-mcp-toolbox/pre-post-processing/python/adk/agent.py similarity index 100% rename from docs/en/user-guide/configuration/pre-post-processing/python/adk/agent.py rename to docs/en/build-with-mcp-toolbox/pre-post-processing/python/adk/agent.py diff --git a/docs/en/user-guide/configuration/pre-post-processing/python/adk/requirements.txt b/docs/en/build-with-mcp-toolbox/pre-post-processing/python/adk/requirements.txt similarity index 100% rename from docs/en/user-guide/configuration/pre-post-processing/python/adk/requirements.txt rename to docs/en/build-with-mcp-toolbox/pre-post-processing/python/adk/requirements.txt diff --git a/docs/en/user-guide/configuration/pre-post-processing/python/agent_test.py b/docs/en/build-with-mcp-toolbox/pre-post-processing/python/agent_test.py similarity index 100% rename from docs/en/user-guide/configuration/pre-post-processing/python/agent_test.py rename to docs/en/build-with-mcp-toolbox/pre-post-processing/python/agent_test.py diff --git a/docs/en/user-guide/configuration/pre-post-processing/python/langchain/agent.py b/docs/en/build-with-mcp-toolbox/pre-post-processing/python/langchain/agent.py similarity index 100% rename from docs/en/user-guide/configuration/pre-post-processing/python/langchain/agent.py rename to docs/en/build-with-mcp-toolbox/pre-post-processing/python/langchain/agent.py diff --git a/docs/en/user-guide/configuration/pre-post-processing/python/langchain/requirements.txt b/docs/en/build-with-mcp-toolbox/pre-post-processing/python/langchain/requirements.txt similarity index 100% rename from docs/en/user-guide/configuration/pre-post-processing/python/langchain/requirements.txt rename to docs/en/build-with-mcp-toolbox/pre-post-processing/python/langchain/requirements.txt diff --git a/docs/en/discord/_index.md b/docs/en/discord/_index.md new file mode 100644 index 000000000000..053a69da8813 --- /dev/null +++ b/docs/en/discord/_index.md @@ -0,0 +1,21 @@ +--- +title: "Discord" +icon: "fab fa-discord" +weight: 2 +description: Join the MCP Toolbox community +manualLink: "https://discord.gg/Dmm69peqjh" +manualLinkTarget: _blank +--- + + + + Redirecting to Discord + + + + +

Connecting to the community... If you are not automatically redirected, please + click here to join our Discord. +

+ + \ No newline at end of file diff --git a/docs/en/integrations/_index.md b/docs/en/integrations/_index.md index dc12f9f0da4b..5c07cc1cc43a 100644 --- a/docs/en/integrations/_index.md +++ b/docs/en/integrations/_index.md @@ -1,7 +1,7 @@ --- title: "Integrations" type: docs -weight: 3 +weight: 4 description: > Integrations connect the MCP Toolbox to your external data sources, unlocking specific sets of tools for your agents. --- diff --git a/docs/en/reference/_index.md b/docs/en/reference/_index.md index 0856818d65e5..1139be54f79f 100644 --- a/docs/en/reference/_index.md +++ b/docs/en/reference/_index.md @@ -1,7 +1,7 @@ --- title: "Reference" type: docs -weight: 7 +weight: 6 description: > This section contains reference documentation. --- diff --git a/docs/en/user-guide/_index.md b/docs/en/user-guide/_index.md index 40dc7c9cacb9..68b518b86077 100644 --- a/docs/en/user-guide/_index.md +++ b/docs/en/user-guide/_index.md @@ -2,7 +2,7 @@ title: "User Guide" type: docs notoc: false -weight: 2 +weight: 3 description: > A complete user guide for MCP Toolbox --- \ No newline at end of file diff --git a/docs/en/user-guide/configuration/_index.md b/docs/en/user-guide/configuration/_index.md index 4e4526969226..70b16cc3966d 100644 --- a/docs/en/user-guide/configuration/_index.md +++ b/docs/en/user-guide/configuration/_index.md @@ -107,3 +107,7 @@ arguments: For more details on configuring different types of prompts, see the [Prompts](./prompts/_index.md). + +--- + +## Explore Configuration Modules \ No newline at end of file diff --git a/docs/en/user-guide/connect-to/_index.md b/docs/en/user-guide/connect-to/_index.md index 5a41f7d6ffae..853cab667105 100644 --- a/docs/en/user-guide/connect-to/_index.md +++ b/docs/en/user-guide/connect-to/_index.md @@ -31,3 +31,5 @@ You do not need to build a full application to use the Toolbox. You can interact By connecting the Toolbox directly to an MCP-compatible IDE, your AI coding assistant gains real-time access to your database schemas, allowing it to write perfectly tailored queries and application code. * **[IDEs](ides/_index.md)**: Guide for connecting your IDE to AlloyDB instances. + +## Available Connection Methods \ No newline at end of file diff --git a/docs/en/user-guide/connect-to/client-sdks/_index.md b/docs/en/user-guide/connect-to/client-sdks/_index.md index ea2247c4140d..c40787cb8324 100644 --- a/docs/en/user-guide/connect-to/client-sdks/_index.md +++ b/docs/en/user-guide/connect-to/client-sdks/_index.md @@ -16,4 +16,4 @@ By using our SDKs, your application can dynamically request tools, bind paramete * **[JavaScript / TypeScript](./javascript-sdk/_index.md)**: Includes the Node.js Core SDK and integrations for the Agent Development Kit (ADK). * **[Go](./go-sdk/_index.md/)**: Includes the Core SDK, plus dedicated packages for building agents with Genkit (`tbgenkit`) and the ADK. -Select your preferred language above to explore installation instructions, quickstart guides, and framework-specific implementations. \ No newline at end of file +Select your preferred language to explore installation instructions, quickstart guides, and framework-specific implementations. \ No newline at end of file diff --git a/docs/en/user-guide/getting-started/_index.md b/docs/en/user-guide/getting-started/_index.md index b4475166aacb..b55d4a5f45fa 100644 --- a/docs/en/user-guide/getting-started/_index.md +++ b/docs/en/user-guide/getting-started/_index.md @@ -10,7 +10,6 @@ Before you spin up your server and start writing code, it is helpful to understa This guide breaks down the core methodologies for using MCP Toolbox, how to think about your tool configurations, and the different ways your applications can connect to it. - ## Prebuilt vs. Custom Configs MCP Toolbox provides two main approaches for tools: **prebuilt** and **custom**. @@ -63,6 +62,18 @@ Being built on the Model Context Protocol (MCP), MCP Toolbox is framework-agnost --- +## Popular Quickstarts + +Ready to dive in? Here are some of the most popular paths to getting your first agent up and running: + +* [**Python SDK Quickstart:**](../../build-with-mcp-toolbox/local_quickstart.md) Build a custom agent from scratch using our native Python client. This is the go-to choice for developers wanting full control over their application logic and orchestration. + +* [**MCP Client Quickstart:**](../../build-with-mcp-toolbox/mcp_quickstart/_index.md) Plug your databases directly into the MCP ecosystem. Perfect for a setup that works instantly with existing MCP-compatible clients and various IDEs. + +{{< notice tip >}} +These are just a few starting points. For a complete list of tutorials, language-specific samples (Go, JS/TS, etc.), and advanced usage, explore the full [Build with MCP Toolbox section](../../build-with-mcp-toolbox/_index.md). +{{< /notice >}} + ## Next Steps Now that you understand the high-level concepts, it's time to build!