BLOG-296 Add MCP configuration and setup instructions #297

squid · 2026-05-22T23:25:16+08:00

squid commented

2026-05-22 23:25:16 +08:00

Description

This PR configures and registers MCP (Model Context Protocol) servers to enhance AI-assisted development workflow, corrects a typo in the PR template, and documents the setup instructions in README.md.

Specifically, the following changes are introduced:

MCP Configuration: Created .agents/mcp_config.json to register MCP servers for gitea, svelte, and cratesio domains.
Documentation: Updated README.md with step-by-step instructions to set up the Go environment, install cratesio-mcp, and configure the Gitea access token.
Template Correction: Corrected a typo in .gitea/PULL_REQUEST_TEMPLATE.yaml.
Git Ignore: Added .antigravitycli directory to .gitignore to prevent tracking of local CLI configurations.

Package Changes

No response

Screenshots

No response

Reference

Resolves #296.

Checklist

A milestone is set
The related issues has been linked to this branch

### Description This PR configures and registers MCP (Model Context Protocol) servers to enhance AI-assisted development workflow, corrects a typo in the PR template, and documents the setup instructions in `README.md`. Specifically, the following changes are introduced: - **MCP Configuration**: Created `.agents/mcp_config.json` to register MCP servers for `gitea`, `svelte`, and `cratesio` domains. - **Documentation**: Updated `README.md` with step-by-step instructions to set up the Go environment, install `cratesio-mcp`, and configure the Gitea access token. - **Template Correction**: Corrected a typo in `.gitea/PULL_REQUEST_TEMPLATE.yaml`. - **Git Ignore**: Added `.antigravitycli` directory to `.gitignore` to prevent tracking of local CLI configurations. ### Package Changes _No response_ ### Screenshots _No response_ ### Reference Resolves #296. ### Checklist - [x] A milestone is set - [x] The related issues has been linked to this branch

squid added 2 commits 2026-05-22 23:25:16 +08:00

BLOG-296 feat: add MCP servers and setup instructions to README

Frontend CI / build (push) Has been cancelled

Details

df60200427

BLOG-296 docs: fix typo

Frontend CI / build (push) Successful in 1m19s

Details

Auto Comment On PR / add_improve_comment (pull_request) Successful in 15s

Details

PR Title Check / pr-title-check (pull_request) Successful in 15s

Details

7dd52966f1

bot commented

2026-05-22 23:25:25 +08:00

/improve

bot commented

2026-05-22 23:25:28 +08:00

PR Code Suggestions ✨

Category	Suggestion	Impact
Possible issue	Explicitly pass required environment variable The `README.md` file instructs users to export a `GITEA_ACCESS_TOKEN` for the Gitea MCP server. However, this environment variable is not included in the server's configuration, which could lead to authentication failures. Explicitly passing required environment variables ensures the server runs correctly. .agents/mcp_config.json [6-8] `"env": { - "GITEA_HOST": "https://git.squidspirit.com" + "GITEA_HOST": "https://git.squidspirit.com", + "GITEA_ACCESS_TOKEN": "${env:GITEA_ACCESS_TOKEN}" }` Suggestion importance[1-10]: 8 __ Why: This suggestion correctly points out a critical inconsistency between the documentation and the configuration. The `README.md` instructs users to set `GITEA_ACCESS_TOKEN`, but it's not passed to the Gitea MCP server in the configuration. This would likely cause authentication failures, so adding it to the `env` block is an important fix.	Medium
Possible issue	Add missing dependency installation step The setup instructions for MCP servers are incomplete as they omit the installation of `bun`. Since the `svelte` MCP server is configured to run with `bunx` in `.agents/mcp_config.json`, `bun` is a required dependency. Adding this step is necessary for users to successfully set up the complete development environment. README.md [82-90] 1. Install Go: Ensure Go is installed on your system to run Go-based MCP servers (such as the Gitea MCP server). -2. Install crates.io MCP: Install `cratesio-mcp` using Cargo: +2. Install Bun: The Svelte MCP server uses `bunx`. Install `bun` by following the instructions on the [official website](https://bun.sh/docs/installation). + +3. Install crates.io MCP: Install `cratesio-mcp` using Cargo: ```bash cargo install cratesio-mcp ``` -3. Configure Environment Variables: Export your Gitea access token: +4. Configure Environment Variables: Export your Gitea access token: Suggestion importance[1-10]: 7 __ Why: The suggestion correctly identifies that the setup instructions in `README.md` are incomplete. The `.agents/mcp_config.json` file specifies using `bunx` for the `svelte` server, which requires `bun` to be installed. Adding this step is crucial for developers to successfully set up the environment.	Medium
General	Pin dependencies to specific versions The `gitea` MCP server uses `@latest` and the `svelte` server uses an unspecified version, which resolves to the latest. This can introduce unexpected breaking changes when new versions are released. Pinning these dependencies to specific versions will ensure a more stable and reproducible environment. .agents/mcp_config.json [5-13] `-"args": ["run", "gitea.com/gitea/gitea-mcp@latest", "-t", "stdio"], +"args": ["run", "gitea.com/gitea/gitea-mcp@v1.0.0", "-t", "stdio"], ... "svelte": { "command": "bunx", - "args": ["-y", "@sveltejs/mcp"] + "args": ["-y", "@sveltejs/mcp@1.0.0"] },` Suggestion importance[1-10]: 6 __ Why: The suggestion provides a valid best practice. Using `@latest` for `gitea-mcp` and an unpinned version for `@sveltejs/mcp` can lead to unexpected breaking changes. Pinning dependencies ensures a stable and reproducible development environment.	Low

## PR Code Suggestions ✨  <table><thead><tr><td><strong>Category</strong></td><td align=left><strong>Suggestion                                                                                                                                    </strong></td><td align=center><strong>Impact</strong></td></tr><tbody><tr><td rowspan=2>Possible issue</td> <td> <details><summary>Explicitly pass required environment variable</summary> ___ **The <code>README.md</code> file instructs users to export a <code>GITEA_ACCESS_TOKEN</code> for the Gitea MCP <br>server. However, this environment variable is not included in the server's <br>configuration, which could lead to authentication failures. Explicitly passing <br>required environment variables ensures the server runs correctly.** [.agents/mcp_config.json [6-8]](https://git.squidspirit.com/squid/blog/src/branch/BLOG-296_add_mcp_servers_for_antigravity/.agents/mcp_config.json#L6-L8) ```diff "env": { - "GITEA_HOST": "https://git.squidspirit.com" + "GITEA_HOST": "https://git.squidspirit.com", + "GITEA_ACCESS_TOKEN": "${env:GITEA_ACCESS_TOKEN}" } ``` <details><summary>Suggestion importance[1-10]: 8</summary> __ Why: This suggestion correctly points out a critical inconsistency between the documentation and the configuration. The `README.md` instructs users to set `GITEA_ACCESS_TOKEN`, but it's not passed to the Gitea MCP server in the configuration. This would likely cause authentication failures, so adding it to the `env` block is an important fix. </details></details></td><td align=center>Medium </td></tr><tr><td> <details><summary>Add missing dependency installation step</summary> ___ **The setup instructions for MCP servers are incomplete as they omit the installation <br>of <code>bun</code>. Since the <code>svelte</code> MCP server is configured to run with <code>bunx</code> in <br><code>.agents/mcp_config.json</code>, <code>bun</code> is a required dependency. Adding this step is necessary <br>for users to successfully set up the complete development environment.** [README.md [82-90]](https://git.squidspirit.com/squid/blog/src/branch/BLOG-296_add_mcp_servers_for_antigravity/README.md#L82-L90) ```diff 1. **Install Go**: Ensure Go is installed on your system to run Go-based MCP servers (such as the Gitea MCP server). -2. **Install crates.io MCP**: Install `cratesio-mcp` using Cargo: +2. **Install Bun**: The Svelte MCP server uses `bunx`. Install `bun` by following the instructions on the [official website](https://bun.sh/docs/installation). + +3. **Install crates.io MCP**: Install `cratesio-mcp` using Cargo: ```bash cargo install cratesio-mcp ``` -3. **Configure Environment Variables**: Export your Gitea access token: +4. **Configure Environment Variables**: Export your Gitea access token: ``` <details><summary>Suggestion importance[1-10]: 7</summary> __ Why: The suggestion correctly identifies that the setup instructions in `README.md` are incomplete. The `.agents/mcp_config.json` file specifies using `bunx` for the `svelte` server, which requires `bun` to be installed. Adding this step is crucial for developers to successfully set up the environment. </details></details></td><td align=center>Medium </td></tr><tr><td rowspan=1>General</td> <td> <details><summary>Pin dependencies to specific versions</summary> ___ **The <code>gitea</code> MCP server uses <code>@latest</code> and the <code>svelte</code> server uses an unspecified version, <br>which resolves to the latest. This can introduce unexpected breaking changes when <br>new versions are released. Pinning these dependencies to specific versions will <br>ensure a more stable and reproducible environment.** [.agents/mcp_config.json [5-13]](https://git.squidspirit.com/squid/blog/src/branch/BLOG-296_add_mcp_servers_for_antigravity/.agents/mcp_config.json#L5-L13) ```diff -"args": ["run", "gitea.com/gitea/gitea-mcp@latest", "-t", "stdio"], +"args": ["run", "gitea.com/gitea/gitea-mcp@v1.0.0", "-t", "stdio"], ... "svelte": { "command": "bunx", - "args": ["-y", "@sveltejs/mcp"] + "args": ["-y", "@sveltejs/mcp@1.0.0"] }, ``` <details><summary>Suggestion importance[1-10]: 6</summary> __ Why: The suggestion provides a valid best practice. Using `@latest` for `gitea-mcp` and an unpinned version for `@sveltejs/mcp` can lead to unexpected breaking changes. Pinning dependencies ensures a stable and reproducible development environment. </details></details></td><td align=center>Low </td></tr></tr></tbody></table>

squid changed title from ~~BLOG-296 feat: Add MCP configuration and setup instructions~~ to BLOG-296 Add MCP configuration and setup instructions

2026-05-22 23:26:02 +08:00

squid added 1 commit 2026-05-22 23:38:51 +08:00

BLOG-296 docs: add Bun requirement for MCP setup in README.md

PR Title Check / pr-title-check (pull_request) Successful in 14s

Details

Frontend CI / build (push) Successful in 1m17s

Details

27491a6aa4

squid commented

2026-05-22 23:39:20 +08:00