Skip to content

Commit d40088c

Browse files
refactor: 更新 README 以反映社区包的名称更改
Co-authored-by: aider (vertex_ai/gemini-2.5-pro) <aider@aider.chat>
1 parent 2347b9a commit d40088c

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README-GEMINI-MCP.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Gemini CLI - MCP / OpenAI Bridge Server (`@google/gemini-mcp-server`)
1+
# Gemini CLI - MCP / OpenAI Bridge Server (`@gemini-community/gemini-mcp-server`)
22

3-
`@google/gemini-mcp-server` is a versatile companion application designed to serve as a powerful extension for the `gemini-cli` ecosystem. It primarily fulfills two core roles:
3+
`@gemini-community/gemini-mcp-server` is a versatile companion application designed to serve as a powerful extension for the `gemini-cli` ecosystem. It primarily fulfills two core roles:
44

55
1. **MCP (Model-Context Protocol) Server**: It hosts and exposes `gemini-cli`'s powerful built-in tools (e.g., `google_web_search`, file system tools) via a standard, discoverable protocol. This allows the core `gemini-cli` model to invoke these tools as needed.
66

@@ -83,7 +83,7 @@ From the root of the `gemini-cli` project, ensure all dependencies are installed
8383
```bash
8484
# From the project root
8585
npm install
86-
npm run build --workspace=@google/gemini-mcp-server
86+
npm run build --workspace=@gemini-community/gemini-mcp-server
8787
```
8888

8989
### 2. Starting the Server
@@ -92,13 +92,13 @@ You can start the server using the `npm run start` command from the root directo
9292

9393
```bash
9494
# Start the server with default configuration
95-
npm run start --workspace=@google/gemini-mcp-server
95+
npm run start --workspace=@gemini-community/gemini-mcp-server
9696

9797
# Start on a different port with debug mode enabled
98-
npm run start --workspace=@google/gemini-mcp-server -- --port=9000 --debug
98+
npm run start --workspace=@gemini-community/gemini-mcp-server -- --port=9000 --debug
9999

100100
# Use a faster model for tool calls
101-
GEMINI_TOOLS_DEFAULT_MODEL=gemini-1.5-flash npm run start --workspace=@google/gemini-mcp-server
101+
GEMINI_TOOLS_DEFAULT_MODEL=gemini-1.5-flash npm run start --workspace=@gemini-community/gemini-mcp-server
102102
```
103103

104104
When the server starts successfully, you will see output similar to this:
@@ -142,32 +142,32 @@ curl http://localhost:8765/v1/chat/completions \
142142

143143
### Telemetry
144144

145-
The `@google/gemini-mcp-server` **does not introduce any new telemetry or data collection mechanisms**.
145+
The `@gemini-community/gemini-mcp-server` **does not introduce any new telemetry or data collection mechanisms**.
146146

147147
It relies entirely on the OpenTelemetry (OTEL) system built into the `@google/gemini-cli-core` package. Therefore, all telemetry data (if enabled) will follow the main `gemini-cli` configuration and be sent to the destination specified in your `settings.json` file.
148148

149149
For details on how to configure and use telemetry, please refer to the [main Gemini CLI telemetry documentation](../../docs/telemetry.md).
150150

151151
### Terms of Service and Privacy Notice
152152

153-
Your use of this server is governed by the Terms of Service and Privacy Policies corresponding to the `gemini-cli` account type you are using for authentication. As a bridge, `@google/gemini-mcp-server` does not collect, store, or process any additional data of its own.
153+
Your use of this server is governed by the Terms of Service and Privacy Policies corresponding to the `gemini-cli` account type you are using for authentication. As a bridge, `@gemini-community/gemini-mcp-server` does not collect, store, or process any additional data of its own.
154154

155155
We strongly recommend you review the [main Gemini CLI Terms of Service and Privacy Notice documentation](../../docs/tos-privacy.md) for details applicable to your account.
156156

157157
---
158158

159-
### Developer Note: Regarding the package name `@google/gemini-mcp-server`
159+
### Developer Note: Regarding the package name `@gemini-community/gemini-mcp-server`
160160

161-
Please note that the name of this package, `@google/gemini-mcp-server`, reflects its origin as an internal component of the official `google-gemini/gemini-cli` monorepo.
161+
Please note that the name of this package, `@gemini-community/gemini-mcp-server`, indicates that it is a community-maintained package.
162162

163-
- **Internal Naming**: This naming is consistent internally within the source code and workspaces of the `gemini-cli` project.
164-
- **Not for Independent Publication**: This package is **not intended to be published independently** to a public npm registry. If you fork this project and wish to publish your modified version, you **must** change the package name to your own scope (e.g., `@your-username/gemini-mcp-server`) to comply with npm's package naming policies and to avoid confusion.
163+
- **Community Driven**: This package is part of the Gemini Community effort to extend the capabilities of `gemini-cli`.
164+
- **Publication**: This package may be published to a public npm registry under the `@gemini-community` scope. If you fork this project and wish to publish your own modified version, you **must** change the package name to your own scope (e.g., `@your-username/gemini-mcp-server`) to comply with npm's package naming policies and to avoid confusion.
165165

166166
----
167167

168-
# Gemini CLI - MCP / OpenAI Bridge Server (`@google/gemini-mcp-server`)
168+
# Gemini CLI - MCP / OpenAI Bridge Server (`@gemini-community/gemini-mcp-server`)
169169

170-
`@google/gemini-mcp-server` 是一个多功能的服务器应用程序,旨在作为 `gemini-cli` 生态系统的强大扩展。它主要承担两个核心角色:
170+
`@gemini-community/gemini-mcp-server` 是一个多功能的服务器应用程序,旨在作为 `gemini-cli` 生态系统的强大扩展。它主要承担两个核心角色:
171171

172172
1. **MCP (Model-Context Protocol) 服务器**: 它为 `gemini-cli` 托管和暴露了一系列强大的内置工具(例如 `google_web_search`),允许 `gemini-cli` 的核心模型通过一个标准的、可发现的协议来调用这些工具。
173173

@@ -239,7 +239,7 @@ Please note that the name of this package, `@google/gemini-mcp-server`, reflects
239239
```bash
240240
# 在项目根目录运行
241241
npm install
242-
npm run build --workspace=@google/gemini-mcp-server
242+
npm run build --workspace=@gemini-community/gemini-mcp-server
243243
```
244244

245245
### 2. 启动服务器
@@ -248,13 +248,13 @@ npm run build --workspace=@google/gemini-mcp-server
248248

249249
```bash
250250
# 启动服务器,使用默认配置
251-
npm run start --workspace=@google/gemini-mcp-server
251+
npm run start --workspace=@gemini-community/gemini-mcp-server
252252

253253
# 在不同端口上启动,并启用调试模式
254-
npm run start --workspace=@google/gemini-mcp-server -- --port=9000 --debug
254+
npm run start --workspace=@gemini-community/gemini-mcp-server -- --port=9000 --debug
255255

256256
# 使用一个更快的模型进行工具调用
257-
GEMINI_TOOLS_DEFAULT_MODEL=gemini-1.5-flash npm run start --workspace=@google/gemini-mcp-server
257+
GEMINI_TOOLS_DEFAULT_MODEL=gemini-1.5-flash npm run start --workspace=@gemini-community/gemini-mcp-server
258258
```
259259

260260
服务器成功启动后,您将看到类似以下的输出:

0 commit comments

Comments
 (0)