Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
1 change: 1 addition & 0 deletions .github/header-checker-lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,5 @@ sourceFileExtensions:
- 'yml'
ignoreFiles:
- 'docs/en/build-with-mcp-toolbox/**'
- 'docs/en/build-with-mcp-toolbox/**/*'
- '**/*oracle*'
3 changes: 3 additions & 0 deletions .github/workflows/deploy_dev_docs_to_cf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/deploy_previous_version_docs_to_cf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/deploy_versioned_docs_to_cf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 1 addition & 0 deletions .github/workflows/docs_lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ on:
pull_request:
paths:
- 'docs/**'
- '.github/workflows/docs**'
- '.ci/lint-docs-*.sh'

jobs:
Expand Down
89 changes: 89 additions & 0 deletions .github/workflows/docs_preview_build_cf.yaml
Original file line number Diff line number Diff line change
@@ -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
103 changes: 48 additions & 55 deletions .github/workflows/docs_preview_deploy_cf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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)*`
});
1 change: 1 addition & 0 deletions docs/en/blogs/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Featured Articles"
icon: "fas fa-newspaper"
weight: 1
description: Toolbox Medium Blogs
manualLink: "https://medium.com/@mcp_toolbox"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
21 changes: 21 additions & 0 deletions docs/en/discord/_index.md
Original file line number Diff line number Diff line change
@@ -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
---

<html>
<head>
<title>Redirecting to Discord</title>
<link rel="canonical" href="https://discord.gg/Dmm69peqjh"/>
<meta http-equiv="refresh" content="0;url=https://discord.gg/Dmm69peqjh"/>
</head>
<body>
<p>Connecting to the community... If you are not automatically redirected, please
<a href="https://discord.gg/Dmm69peqjh">click here to join our Discord</a>.
</p>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/en/integrations/_index.md
Original file line number Diff line number Diff line change
@@ -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.
---
Expand Down
2 changes: 1 addition & 1 deletion docs/en/reference/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Reference"
type: docs
weight: 7
weight: 6
description: >
This section contains reference documentation.
---
2 changes: 1 addition & 1 deletion docs/en/user-guide/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "User Guide"
type: docs
notoc: false
weight: 2
weight: 3
description: >
A complete user guide for MCP Toolbox
---
4 changes: 4 additions & 0 deletions docs/en/user-guide/configuration/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,3 +107,7 @@ arguments:

For more details on configuring different types of prompts, see the
[Prompts](./prompts/_index.md).

---

## Explore Configuration Modules
2 changes: 2 additions & 0 deletions docs/en/user-guide/connect-to/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Loading
Loading