Skip to content

Commit 35d4363

Browse files
committed
docs: update README translation using Qwen model
1 parent e963853 commit 35d4363

File tree

1 file changed

+57
-55
lines changed

1 file changed

+57
-55
lines changed

README_zh-CN.md

Lines changed: 57 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,25 @@
1010

1111
魔搭社区([ModelScope](https://modelscope.cn))官方 MCP 服务器,为你的 AI 应用提供一站式接入能力,轻松访问平台海量的模型、数据集、创空间、论文、MCP 服务,以及各种 AIGC 生成能力。
1212

13-
## 功能特性
13+
## 核心功能
1414

15-
- 🎨 **AI 图像生成** - 使用 AIGC 模型从提示词生成图像(文生图),或者转换现有图像(图生图
16-
- 🔍 **资源发现** - 搜索和发现 ModelScope 资源,包括模型、数据集、创空间(AI 应用)、论文和 MCP 服务器,支持高级过滤选项
17-
- 📋 **资源详情** _(即将推出)_ - 获取特定资源的明细数据
18-
- 📖 **文档搜索** _(即将推出)_ - ModelScope 文档和文章进行语义搜索
19-
- 🚀 **Gradio API 集成** _(即将推出)_ - 调用任何预配置的 ModelScope 创空间(AI 应用)暴露的 Gradio API
20-
- 🔐 **上下文信息** - 访问当前操作上下文,包括认证用户信息和环境详情
15+
- 🎨 **AI 图像生成** - 借助 AIGC 模型,轻松实现文生图(根据描述生成图像)或图生图(转换现有图像
16+
- 🔍 **资源发现** - 快速搜索和发现 ModelScope 平台上的模型、数据集、创空间(AI 应用)、研究论文和 MCP 服务,支持多种高级筛选
17+
- 📋 **资源详情** _(即将推出)_ - 深入了解特定资源的详细信息
18+
- 📖 **文档搜索** _(即将推出)_ - 智能语义搜索 ModelScope 文档和文章内容
19+
- 🚀 **Gradio API 集成** _(即将推出)_ - 调用任意预配置的 ModelScope 创空间暴露的 Gradio API
20+
- 🔐 **上下文信息** - 实时获取当前操作环境信息,包括用户认证状态和运行环境详情
2121

22-
## 🚀 快速开始
22+
## 🚀 快速上手
2323

2424
### 1. 获取您的 API Token
2525

26-
1. 访问 [ModelScope](https://modelscope.cn/home) 站点并登录您的账户
27-
2. 导航至 **[首页][访问令牌]** 获取或创建您的 API Token
26+
1. 访问 [ModelScope 魔搭](https://modelscope.cn/home) 并登录您的账户
27+
2. 进入 **[首页][访问令牌]** 页面获取或创建您的 API Token
2828

29-
> 📖 详细说明请参考 [ModelScope 访问令牌](https://modelscope.cn/docs/accounts/token)
29+
> 📖 更详细的说明,请参考 [ModelScope 访问令牌文档](https://modelscope.cn/docs/accounts/token)
3030
31-
### 2. MCP 客户端集成
31+
### 2. 集成到 MCP 客户端
3232

3333
将以下 JSON 配置添加到您的 MCP 客户端配置文件中:
3434

@@ -46,7 +46,7 @@
4646
}
4747
```
4848

49-
或者,您可以使用预构建的 Docker 镜像:
49+
或者,您也可以使用预构建的 Docker 镜像:
5050

5151
```json
5252
{
@@ -68,33 +68,33 @@
6868

6969
更多详情请参考 [MCP JSON 配置标准](https://gofastmcp.com/integrations/mcp-json-configuration#mcp-json-configuration-standard)
7070

71-
此格式在 MCP 生态系统中被广泛采用
71+
这一配置格式在 MCP 生态中被广泛采用
7272

73-
- **Cherry Studio**: 参见 [Cherry Studio MCP 配置](https://docs.cherry-ai.com/advanced-basic/mcp/config)
74-
- **Claude Desktop**: 使用 `~/.claude/claude_desktop_config.json`
75-
- **Cursor**: 使用 `~/.cursor/mcp.json`
76-
- **VS Code**: 使用工作区 `.vscode/mcp.json`
77-
- **其他客户端**: 许多 MCP 兼容的应用程序都遵循此标准
73+
- **Cherry Studio**: 参考 [Cherry Studio MCP 配置](https://docs.cherry-ai.com/advanced-basic/mcp/config)
74+
- **Claude Desktop**: 配置文件位于 `~/.claude/claude_desktop_config.json`
75+
- **Cursor**: 配置文件位于 `~/.cursor/mcp.json`
76+
- **VS Code**: 工作区配置文件 `.vscode/mcp.json`
77+
- **其他客户端**: 多数 MCP 兼容应用均支持此标准
7878

79-
## 🛠️ 开发
79+
## 🛠️ 开发指南
8080

81-
### 环境设置
81+
### 环境搭建
8282

83-
1. **克隆和设置**
83+
1. **克隆并设置项目**
8484

8585
```bash
8686
git clone https://github.com/modelscope/modelscope-mcp-server.git
8787
cd modelscope-mcp-server
8888
uv sync
8989
```
9090

91-
2. **激活环境**或使用您的 IDE):
91+
2. **激活环境**或在您的 IDE 中使用):
9292

9393
```bash
9494
source .venv/bin/activate # Linux/macOS
9595
```
9696

97-
3. **设置您的 API Token**(Token 设置请参见快速开始部分):
97+
3. **配置您的 API Token**(Token 获取方法请参考快速上手部分):
9898

9999
```bash
100100
export MODELSCOPE_API_TOKEN="your-api-token"
@@ -103,32 +103,32 @@
103103

104104
### 运行演示脚本
105105

106-
运行快速演示以探索服务器的功能
106+
运行快速演示,体验服务器的核心功能
107107

108108
```bash
109109
uv run python demo.py
110110
```
111111

112-
使用 `--full` 标志进行全面功能演示
112+
使用 `--full` 参数可体验完整功能演示
113113

114114
```bash
115115
uv run python demo.py --full
116116
```
117117

118-
### 本地运行服务器
118+
### 本地启动服务器
119119

120120
```bash
121-
# 标准 stdio 传输(默认
121+
# 标准 stdio 传输(默认模式
122122
uv run modelscope-mcp-server
123123

124-
# 用于 Web 集成的可流式 HTTP 传输
124+
# 面向 Web 集成的流式 HTTP 传输
125125
uv run modelscope-mcp-server --transport http
126126

127-
# 自定义端口的 HTTP/SSE 传输(默认:8000)
127+
# 自定义端口的 HTTP/SSE 传输(默认端口:8000)
128128
uv run modelscope-mcp-server --transport [http/sse] --port 8080
129129
```
130130

131-
对于 HTTP/SSE 模式,在您的 MCP 客户端配置中使用本地 URL 连接:
131+
HTTP/SSE 模式下,您可以在 MCP 客户端配置中使用本地 URL 连接:
132132

133133
```json
134134
{
@@ -140,41 +140,43 @@ uv run modelscope-mcp-server --transport [http/sse] --port 8080
140140
}
141141
```
142142

143-
您也可以使用 [MCP Inspector](https://github.com/modelcontextprotocol/inspector) 工具调试服务器:
143+
您还可以使用 [MCP Inspector](https://github.com/modelcontextprotocol/inspector) 工具调试服务器:
144144

145145
```bash
146+
# 使用 stdio 传输在 UI 模式下运行(可根据需要在 Web UI 中切换到 HTTP/SSE)
146147
npx @modelcontextprotocol/inspector uv run modelscope-mcp-server
147-
```
148148

149-
默认使用 stdio 传输;根据需要在 Web UI 中切换到 HTTP/SSE。
149+
# 使用 HTTP 传输在 CLI 模式下运行(可跨工具、资源和提示进行操作)
150+
npx @modelcontextprotocol/inspector --cli http://127.0.0.1:8000/mcp/ --transport http --method tools/list
151+
```
150152

151-
### 测试
153+
### 运行测试
152154

153155
```bash
154-
# 运行所有测试
156+
# 运行全部测试
155157
uv run pytest
156158

157-
# 运行特定测试文件
159+
# 运行指定测试文件
158160
uv run pytest tests/test_search_papers.py
159161

160-
# 带覆盖率报告
162+
# 生成覆盖率报告
161163
uv run pytest --cov=src --cov-report=html
162164
```
163165

164166
## 🔄 持续集成
165167

166-
本项目使用 GitHub Actions 进行自动化 CI/CD 工作流,在每次推送和拉取请求时运行
168+
本项目使用 GitHub Actions 实现自动化 CI/CD 工作流,每次推送和拉取请求时都会自动运行
167169

168170
### 自动化检查
169171

170-
- **[Lint](https://github.com/modelscope/modelscope-mcp-server/actions/workflows/lint.yml)** - 使用 pre-commit hooks 进行代码格式化、代码检查和风格检查
171-
- **🧪 [Test](https://github.com/modelscope/modelscope-mcp-server/actions/workflows/test.yml)** - 跨所有支持的 Python 版本进行全面测试
172+
- **[Lint](https://github.com/modelscope/modelscope-mcp-server/actions/workflows/lint.yml)** - 使用 pre-commit hooks 进行代码格式化、代码检查和风格规范
173+
- **🧪 [Test](https://github.com/modelscope/modelscope-mcp-server/actions/workflows/test.yml)** - 跨所有支持的 Python 版本进行全面功能测试
172174
- **🔍 [CodeQL](https://github.com/modelscope/modelscope-mcp-server/actions/workflows/codeql.yml)** - 安全漏洞扫描和代码质量分析
173-
- **🔒 [Gitleaks](https://github.com/modelscope/modelscope-mcp-server/actions/workflows/gitleaks.yml)** - 检测密码、API 密钥和令牌等敏感信息
175+
- **🔒 [Gitleaks](https://github.com/modelscope/modelscope-mcp-server/actions/workflows/gitleaks.yml)** - 检测代码中可能泄露的密码、API 密钥和访问令牌
174176

175177
### 本地开发检查
176178

177-
在提交 PR 之前在本地运行相同的检查
179+
提交 PR 前,请在本地运行相同的检查
178180

179181
```bash
180182
# 安装并运行 pre-commit hooks
@@ -185,41 +187,41 @@ uv run pre-commit run --all-files
185187
uv run pytest
186188
```
187189

188-
[Actions 标签页](https://github.com/modelscope/modelscope-mcp-server/actions) 中监控 CI 状态。
190+
您可以在 [Actions 标签页](https://github.com/modelscope/modelscope-mcp-server/actions) 中查看 CI 状态。
189191

190-
## 📦 发布管理
192+
## 📦 版本发布
191193

192-
本项目使用 GitHub Actions 进行自动化发布管理。创建新版本的步骤:
194+
本项目使用 GitHub Actions 实现自动化版本发布管理。创建新版本的步骤:
193195

194-
1. **更新版本**,使用版本更新脚本:
196+
1. **更新版本号**,使用版本更新脚本:
195197

196198
```bash
197199
uv run python scripts/bump_version.py [patch|minor|major]
198-
# 或设置特定版本: uv run python scripts/bump_version.py set 1.2.3.dev1
200+
# 或设置指定版本: uv run python scripts/bump_version.py set 1.2.3.dev1
199201
```
200202

201-
2. **提交并打标签**按照脚本输出的说明):
203+
2. **提交并打标签**请按照脚本输出的说明操作):
202204

203205
```bash
204206
git add src/modelscope_mcp_server/_version.py
205207
git commit -m "chore: bump version to v{version}"
206208
git tag v{version} && git push origin v{version}
207209
```
208210

209-
3. **自动发布** - GitHub Actions 将自动
211+
3. **自动发布** - GitHub Actions 将自动完成
210212
- 创建新的 [GitHub Release](https://github.com/modelscope/modelscope-mcp-server/releases)
211213
- 发布包到 [PyPI 仓库](https://pypi.org/project/modelscope-mcp-server/)
212214
- 构建并推送 Docker 镜像到 [GitHub Container Registry](https://github.com/modelscope/modelscope-mcp-server/pkgs/container/modelscope-mcp-server)
213215

214-
## 🤝 贡献
216+
## 🤝 贡献指南
215217

216-
我们欢迎贡献!请确保您的 PR:
218+
我们热烈欢迎您的贡献!请确保您的 PR:
217219

218220
- 包含相关测试并通过所有 CI 检查
219-
- 为新功能更新文档
220-
- 遵循常规提交格式
221+
- 为新增功能补充相应文档
222+
- 遵循常规提交格式规范
221223

222-
## 📚 参考资料
224+
## 📚 相关资源
223225

224226
- **[Model Context Protocol](https://modelcontextprotocol.io/)** - 官方 MCP 文档
225227
- **[FastMCP v2](https://github.com/jlowin/fastmcp)** - 高性能 MCP 框架

0 commit comments

Comments
 (0)