docs: fix docs linting (#1520)

Author: Yuan325

CONTRIBUTING.md

@@ -27,7 +27,6 @@ This project follows
 
 > [!NOTE]
 > New contributions should always include both unit and integration tests.
- 
 
 All submissions, including submissions by project members, require review. We
 use GitHub pull requests for this purpose. Consult
@@ -37,14 +36,14 @@ information on using pull requests.
 ### Code reviews
 
 * Within 2-5 days, a reviewer will review your PR. They may approve it, or request
-changes. 
+changes.
 * When requesting changes, reviewers should self-assign the PR to ensure
 they are aware of any updates.
 * If additional changes are needed, push additional commits to your PR branch -
-this helps the reviewer know which parts of the PR have changed. 
+this helps the reviewer know which parts of the PR have changed.
 * Commits will be
 squashed when merged.
-* Please follow up with changes promptly. 
+* Please follow up with changes promptly.
 * If a PR is awaiting changes by the
 author for more than 10 days, maintainers may mark that PR as Draft. PRs that
 are inactive for more than 30 days may be closed.
@@ -53,12 +52,16 @@ are inactive for more than 30 days may be closed.
 
 Please create an
 [issue](https://github.com/googleapis/genai-toolbox/issues) before
-implementation to ensure we can accept the contribution and no duplicated work. This issue
-should include an overview of the API design. If you have any questions, reach out on our
-[Discord](https://discord.gg/Dmm69peqjh) to chat directly with the team. 
+implementation to ensure we can accept the contribution and no duplicated work.
+This issue should include an overview of the API design. If you have any
+questions, reach out on our [Discord](https://discord.gg/Dmm69peqjh) to chat
+directly with the team.
 
 > [!NOTE]
-> New tools can be added for [pre-existing data sources](https://github.com/googleapis/genai-toolbox/tree/main/internal/sources). However, any new database source should also include at least one new tool type.
+> New tools can be added for [pre-existing data
+> sources](https://github.com/googleapis/genai-toolbox/tree/main/internal/sources).
+> However, any new database source should also include at least one new tool
+> type.
 
 ### Adding a New Database Source
 
@@ -196,7 +199,7 @@ detailed description of your changes and any requests for long term testing
 resources.
 
 * **Title:** All pull request title should follow the formatting of
- [Conventional 
+ [Conventional
  Commit](https://www.conventionalcommits.org/) guidelines: `<type>[optional
  scope]: description`. For example, if you are adding a new field in postgres
  source, the title should be `feat(source/postgres): add support for

DEVELOPER.md

@@ -59,12 +59,14 @@ cancel_hotel: <- tool name
 
 Tool name is the identifier used by a Large Language Model (LLM) to invoke a
 specific tool.
+
 * Custom tools: The user can define any name they want. The below guidelines
  do not apply.
 * Pre-built tools: The tool name is predefined and cannot be changed. It
 should follow the guidelines.
 
 The following guidelines apply to tool names:
+
 * Should use underscores over hyphens (e.g., `list_collections` instead of
  `list-collections`).
 * Should not have the product name in the name (e.g., `list_collections` instead
@@ -79,6 +81,7 @@ The following guidelines apply to tool names:
 Tool kind serves as a category or type that a user can assign to a tool.
 
 The following guidelines apply to tool kinds:
+
 * Should user hyphens over underscores (e.g. `firestore-list-collections` or
  `firestore_list_colelctions`).
 * Should use product name in name (e.g. `firestore-list-collections` over

README.md

@@ -175,7 +175,8 @@ To run Toolbox from binary:
 ```
 
 ⓘ **NOTE:** 
-Toolbox enables dynamic reloading by default. To disable, use the `--disable-reload` flag.
+Toolbox enables dynamic reloading by default. To disable, use the
+`--disable-reload` flag.
 
 </details>
 
@@ -194,30 +195,37 @@ us-central1-docker.pkg.dev/database-toolbox/toolbox/toolbox:$VERSION \
 ```
 
 ⓘ **NOTE:** 
-The `-v` flag mounts your local `tools.yaml` into the container, and `-p` maps the container's port `5000` to your host's port `5000`.
+The `-v` flag mounts your local `tools.yaml` into the container, and `-p` maps
+the container's port `5000` to your host's port `5000`.
 
 </details>
 
 <details>
 
 <summary>Source</summary>
 
-To run the server directly from source, navigate to the project root directory and run:
+To run the server directly from source, navigate to the project root directory
+and run:
 
 ```sh
 go run .
 ```
 
 ⓘ **NOTE:** 
-This command runs the project from source, and is more suitable for development and testing. It does **not** compile a binary into your `$GOPATH`. If you want to compile a binary instead, refer the [Developer Documentation](./DEVELOPER.md#building-the-binary).
+This command runs the project from source, and is more suitable for development
+and testing. It does **not** compile a binary into your `$GOPATH`. If you want
+to compile a binary instead, refer the [Developer
+Documentation](./DEVELOPER.md#building-the-binary).
 
 </details>
 
 <details>
 
 <summary>Homebrew</summary>
 
-If you installed Toolbox using [Homebrew](https://brew.sh/), the `toolbox` binary is available in your system path. You can start the server with the same command:
+If you installed Toolbox using [Homebrew](https://brew.sh/), the `toolbox`
+binary is available in your system path. You can start the server with the same
+command:
 
 ```sh
 toolbox --tools-file "tools.yaml"
@@ -232,7 +240,6 @@ For more detailed documentation on deploying to different environments, check
 out the resources in the [How-to
 section](https://googleapis.github.io/genai-toolbox/how-to/)
 
-
 ### Integrating your application
 
 Once your server is up and running, you can load the tools into your
@@ -777,6 +784,7 @@ Since the project is in a pre-release stage (version `0.x.y`), we follow the
 standard conventions for initial development:
 
 ### Pre-1.0.0 Versioning
+
 While the major version is `0`, the public API should be considered unstable.
 The version will be incremented as follows:
 
@@ -786,6 +794,7 @@ The version will be incremented as follows:
  backward-compatible bug fixes.
 
 ### Post-1.0.0 Versioning
+
 Once the project reaches a stable `1.0.0` release, the versioning will follow
 the more common convention:
 

docs/en/getting-started/configure.md

@@ -22,6 +22,7 @@ etc., you could use environment variables instead with the format `${ENV_NAME}`.
  user: ${USER_NAME}
  password: ${PASSWORD}
 ```
+
 A default value can be specified like `${ENV_NAME:default}`.
 
 ```yaml

docs/en/getting-started/introduction/_index.md

@@ -108,6 +108,7 @@ To install Toolbox using Homebrew on macOS or Linux:
 ```sh
 brew install mcp-toolbox
 ```
+
 {{% /tab %}}
 {{% tab header="Compile from source" lang="en" %}}
 
@@ -138,16 +139,18 @@ Toolbox enables dynamic reloading by default. To disable, use the
 
 #### Launching Toolbox UI
 
-To launch Toolbox's interactive UI, use the `--ui` flag. This allows you to test tools and toolsets
-with features such as authorized parameters. To learn more, visit [Toolbox UI](../../how-to/toolbox-ui/index.md).
+To launch Toolbox's interactive UI, use the `--ui` flag. This allows you to test
+tools and toolsets with features such as authorized parameters. To learn more,
+visit [Toolbox UI](../../how-to/toolbox-ui/index.md).
 
 ```sh
 ./toolbox --ui
 ```
 
 #### Homebrew Users
 
-If you installed Toolbox using Homebrew, the `toolbox` binary is available in your system path. You can start the server with the same command:
+If you installed Toolbox using Homebrew, the `toolbox` binary is available in
+your system path. You can start the server with the same command:
 
 ```sh
 toolbox --tools-file "tools.yaml"
@@ -185,7 +188,8 @@ async with ToolboxClient("http://127.0.0.1:5000") as client:
 {{< /highlight >}}
 
 For more detailed instructions on using the Toolbox Core SDK, see the
-[project's README](https://github.com/googleapis/mcp-toolbox-sdk-python/blob/main/packages/toolbox-core/README.md).
+[project's
+README](https://github.com/googleapis/mcp-toolbox-sdk-python/blob/main/packages/toolbox-core/README.md).
 
 {{% /tab %}}
 {{% tab header="LangChain" lang="en" %}}
@@ -206,7 +210,8 @@ async with ToolboxClient("http://127.0.0.1:5000") as client:
 {{< /highlight >}}
 
 For more detailed instructions on using the Toolbox LangChain SDK, see the
-[project's README](https://github.com/googleapis/mcp-toolbox-sdk-python/blob/main/packages/toolbox-langchain/README.md).
+[project's
+README](https://github.com/googleapis/mcp-toolbox-sdk-python/blob/main/packages/toolbox-langchain/README.md).
 
 {{% /tab %}}
 {{% tab header="Llamaindex" lang="en" %}}
@@ -228,7 +233,8 @@ async with ToolboxClient("http://127.0.0.1:5000") as client:
 {{< /highlight >}}
 
 For more detailed instructions on using the Toolbox Llamaindex SDK, see the
-[project's README](https://github.com/googleapis/genai-toolbox-llamaindex-python/blob/main/README.md).
+[project's
+README](https://github.com/googleapis/genai-toolbox-llamaindex-python/blob/main/README.md).
 
 {{% /tab %}}
 {{< /tabpane >}}
@@ -343,7 +349,8 @@ const tools = toolboxTools.map(getTool);
 {{< /tabpane >}}
 
 For more detailed instructions on using the Toolbox Core SDK, see the
-[project's README](https://github.com/googleapis/mcp-toolbox-sdk-js/blob/main/packages/toolbox-core/README.md).
+[project's
+README](https://github.com/googleapis/mcp-toolbox-sdk-js/blob/main/packages/toolbox-core/README.md).
 
 #### Go
 
@@ -590,7 +597,8 @@ func main() {
 {{< /tabpane >}}
 
 For more detailed instructions on using the Toolbox Go SDK, see the
-[project's README](https://github.com/googleapis/mcp-toolbox-sdk-go/blob/main/core/README.md).
+[project's
+README](https://github.com/googleapis/mcp-toolbox-sdk-go/blob/main/core/README.md).
 
 For end-to-end samples on using the Toolbox Go SDK with orchestration
 frameworks, see the [project's

docs/en/getting-started/local_quickstart.md

@@ -14,12 +14,14 @@ description: >
 This guide assumes you have already done the following:
 
 1. Installed [Python 3.9+][install-python] (including [pip][install-pip] and
- your preferred virtual environment tool for managing dependencies e.g. [venv][install-venv]).
+ your preferred virtual environment tool for managing dependencies e.g.
+ [venv][install-venv]).
 1. Installed [PostgreSQL 16+ and the `psql` client][install-postgres].
 
 [install-python]: https://wiki.python.org/moin/BeginnersGuide/Download
 [install-pip]: https://pip.pypa.io/en/stable/installation/
-[install-venv]: https://packaging.python.org/en/latest/tutorials/installing-packages/#creating-virtual-environments
+[install-venv]:
+ https://packaging.python.org/en/latest/tutorials/installing-packages/#creating-virtual-environments
 [install-postgres]: https://www.postgresql.org/download/
 
 ### Cloud Setup (Optional)
@@ -36,9 +38,10 @@ This guide assumes you have already done the following:
 In this section, we will write and run an agent that will load the Tools
 from Toolbox.
 
-{{< notice tip>}} If you prefer to experiment within a Google Colab environment,
-you can connect to a
-[local runtime](https://research.google.com/colaboratory/local-runtimes.html).
+{{< notice tip>}}
+If you prefer to experiment within a Google Colab environment, you can connect
+to a [local
+runtime](https://research.google.com/colaboratory/local-runtimes.html).
 {{< /notice >}}
 
 1. In a new terminal, install the SDK package.
@@ -148,5 +151,6 @@ Documentation](https://github.com/googleapis/python-genai?tab=readme-ov-file#man
  ```
 
 {{< notice info >}}
-For more information, visit the [Python SDK repo](https://github.com/googleapis/mcp-toolbox-sdk-python).
+For more information, visit the [Python SDK
+repo](https://github.com/googleapis/mcp-toolbox-sdk-python).
 {{</ notice >}}

docs/en/getting-started/local_quickstart_go.md

@@ -17,12 +17,15 @@ This guide assumes you have already done the following:
 [install-postgres]: https://www.postgresql.org/download/
 
 ### Cloud Setup (Optional)
+
 {{< regionInclude "quickstart/shared/cloud_setup.md" "cloud_setup" >}}
 
 ## Step 1: Set up your database
+
 {{< regionInclude "quickstart/shared/database_setup.md" "database_setup" >}}
 
 ## Step 2: Install and configure Toolbox
+
 {{< regionInclude "quickstart/shared/configure_toolbox.md" "configure_toolbox" >}}
 
 ## Step 3: Connect your agent to Toolbox
@@ -51,14 +54,12 @@ from Toolbox.
 
 {{< include "quickstart/go/langchain/quickstart.go" >}}
 
-
 {{< /tab >}}
 
 {{< tab header="Genkit Go" lang="go" >}}
 
 {{< include "quickstart/go/genkit/quickstart.go" >}}
 
-
 {{< /tab >}}
 
 {{< tab header="Go GenAI" lang="go" >}}
@@ -71,7 +72,6 @@ from Toolbox.
 
 {{< include "quickstart/go/openAI/quickstart.go" >}}
 
-
 {{< /tab >}}
 {{< /tabpane >}}
 

docs/en/getting-started/local_quickstart_js.md

@@ -17,12 +17,15 @@ This guide assumes you have already done the following:
 [install-postgres]: https://www.postgresql.org/download/
 
 ### Cloud Setup (Optional)
+
 {{< regionInclude "quickstart/shared/cloud_setup.md" "cloud_setup" >}}
 
 ## Step 1: Set up your database
+
 {{< regionInclude "quickstart/shared/database_setup.md" "database_setup" >}}
 
 ## Step 2: Install and configure Toolbox
+
 {{< regionInclude "quickstart/shared/configure_toolbox.md" "configure_toolbox" >}}
 
 ## Step 3: Connect your agent to Toolbox
@@ -36,7 +39,8 @@ from Toolbox.
  npm init -y
  ```
 
-1. In a new terminal, install the [SDK](https://www.npmjs.com/package/@toolbox-sdk/core).
+1. In a new terminal, install the
+ [SDK](https://www.npmjs.com/package/@toolbox-sdk/core).
 
  ```bash
  npm install @toolbox-sdk/core
@@ -59,7 +63,8 @@ npm install @google/genai
 {{< /tab >}}
 {{< /tabpane >}}
 
-1. Create a new file named `hotelAgent.js` and copy the following code to create an agent:
+1. Create a new file named `hotelAgent.js` and copy the following code to create
+ an agent:
 
  {{< tabpane persist=header >}}
 {{< tab header="LangChain" lang="js" >}}
@@ -95,5 +100,6 @@ npm install @google/genai
  ```
 
 {{< notice info >}}
-For more information, visit the [JS SDK repo](https://github.com/googleapis/mcp-toolbox-sdk-js).
+For more information, visit the [JS SDK
+repo](https://github.com/googleapis/mcp-toolbox-sdk-js).
 {{</ notice >}}

docs/en/getting-started/quickstart/shared/cloud_setup.md

@@ -5,16 +5,13 @@ If you plan to use **Google Cloud’s Vertex AI** with your agent (e.g., using
 local development:
 
 1. [Install the Google Cloud CLI](https://cloud.google.com/sdk/docs/install)
-1. [Set up Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/set-up-adc-local-dev-environment)
+1. [Set up Application Default Credentials
+ (ADC)](https://cloud.google.com/docs/authentication/set-up-adc-local-dev-environment)
 1. Set your project and enable Vertex AI
 
  ```bash
  gcloud config set project YOUR_PROJECT_ID
  gcloud services enable aiplatform.googleapis.com
  ```
 
-[install-python]: https://wiki.python.org/moin/BeginnersGuide/Download
-[install-pip]: https://pip.pypa.io/en/stable/installation/
-[install-venv]: https://packaging.python.org/en/latest/tutorials/installing-packages/#creating-virtual-environments
-[install-postgres]: https://www.postgresql.org/download/
 <!-- [END cloud_setup] -->

docs/en/how-to/connect-ide/alloydb_pg_admin_mcp.md

@@ -11,4 +11,4 @@ description: >
  <link rel="canonical" href="https://cloud.google.com/alloydb/docs/create-database-with-mcp-toolbox"/>
  <meta http-equiv="refresh" content="0;url=https://cloud.google.com/alloydb/docs/create-database-with-mcp-toolbox"/>
  </head>
-</html>
+</html>