Skip to content

Commit b48c762

Browse files
committed
docs: update README
1 parent 9ff0638 commit b48c762

File tree

1 file changed

+53
-29
lines changed

1 file changed

+53
-29
lines changed

README.md

Lines changed: 53 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
[![Docker](https://img.shields.io/badge/docker-supported-blue?logo=docker)](https://github.com/modelscope/modelscope-mcp-server/blob/main/Dockerfile)
55
[![GitHub Container Registry](https://img.shields.io/badge/container-registry-blue?logo=github)](https://github.com/modelscope/modelscope-mcp-server/pkgs/container/modelscope-mcp-server)
66
[![License](https://img.shields.io/github/license/modelscope/modelscope-mcp-server.svg)](https://github.com/modelscope/modelscope-mcp-server/blob/main/LICENSE)
7+
[![Lint](https://github.com/modelscope/modelscope-mcp-server/actions/workflows/lint.yml/badge.svg)](https://github.com/modelscope/modelscope-mcp-server/actions/workflows/lint.yml)
8+
[![Test](https://github.com/modelscope/modelscope-mcp-server/actions/workflows/test.yml/badge.svg)](https://github.com/modelscope/modelscope-mcp-server/actions/workflows/test.yml)
79

810
A Model Context Protocol (MCP) server that integrates with [ModelScope](https://modelscope.cn)'s ecosystem, providing seamless access to AI models, datasets, apps, papers, and generation capabilities through popular MCP clients.
911

@@ -21,7 +23,7 @@ A Model Context Protocol (MCP) server that integrates with [ModelScope](https://
2123
### 1. Get Your API Token
2224

2325
1. Visit [ModelScope](https://modelscope.cn/home) and sign in to your account
24-
2. Navigate to **[Home][Access Tokens]** to retrieve your default API token or create a new one
26+
2. Navigate to **[Home][Access Tokens]** to retrieve or create your API token
2527

2628
> 📖 For detailed instructions, refer to the [ModelScope Token Documentation](https://modelscope.cn/docs/accounts/token)
2729
@@ -85,23 +87,17 @@ This format is widely adopted across the MCP ecosystem:
8587
uv sync
8688
```
8789

88-
2. **Activate Environment**:
90+
2. **Activate Environment** (or use your IDE):
8991

9092
```bash
9193
source .venv/bin/activate # Linux/macOS
92-
# or via your IDE
9394
```
9495

95-
3. **Set Your API Token Environment Variable**:
96+
3. **Set Your API Token** (see Quick Start section for token setup):
9697

9798
```bash
9899
export MODELSCOPE_API_TOKEN="your-api-token"
99-
```
100-
101-
Or, you can set the API token in the `.env` file (under the project root) for convenience:
102-
103-
```env
104-
MODELSCOPE_API_TOKEN="your-api-token"
100+
# Or create .env file: echo 'MODELSCOPE_API_TOKEN="your-api-token"' > .env
105101
```
106102

107103
### Running the Demo Script
@@ -112,7 +108,7 @@ Run a quick demo to explore the server's capabilities:
112108
uv run python demo.py
113109
```
114110

115-
Use the `--full` flag to demonstrate all available features:
111+
Use the `--full` flag for comprehensive feature demonstration:
116112

117113
```bash
118114
uv run python demo.py --full
@@ -149,49 +145,77 @@ You can also debug the server using the [MCP Inspector](https://github.com/model
149145
npx @modelcontextprotocol/inspector uv run modelscope-mcp-server
150146
```
151147

152-
The above command uses stdio transport by default; you can switch to HTTP or SSE in the Web UI as needed.
148+
Uses stdio transport by default; switch to HTTP/SSE in the Web UI as needed.
153149

154150
### Testing
155151

156-
Run the complete test suite:
157-
158152
```bash
159-
# Basic test run
153+
# Run all tests
160154
uv run pytest
161155

162-
# Run tests for a specific file
156+
# Run specific test file
163157
uv run pytest tests/test_search_papers.py
164158

165159
# With coverage report
166-
uv run pytest --cov=src --cov=examples --cov-report=html
160+
uv run pytest --cov=src --cov-report=html
167161
```
168162

169-
### Code Quality
163+
## 🔄 Continuous Integration
164+
165+
This project uses GitHub Actions for automated CI/CD workflows that run on every push and pull request:
170166

171-
This project uses `pre-commit` hooks for automated code formatting, linting, and type checking:
167+
### Automated Checks
168+
169+
- **🔍 [CodeQL Analysis](https://github.com/modelscope/modelscope-mcp-server/actions/workflows/codeql.yml)** - Security vulnerability scanning and code quality analysis
170+
- **[Lint](https://github.com/modelscope/modelscope-mcp-server/actions/workflows/lint.yml)** - Code formatting, linting, and style checks using pre-commit hooks
171+
- **🧪 [Test Suite](https://github.com/modelscope/modelscope-mcp-server/actions/workflows/test.yml)** - Comprehensive testing across Python 3.10, 3.11, and 3.12
172+
173+
### Local Development Checks
174+
175+
Run the same checks locally before submitting PRs:
172176

173177
```bash
174-
# Install hooks
178+
# Install and run pre-commit hooks
175179
uv run pre-commit install
176-
177-
# Run all checks manually
178180
uv run pre-commit run --all-files
181+
182+
# Run tests
183+
uv run pytest
179184
```
180185

181-
**All PRs must pass these checks and include appropriate tests.**
186+
Monitor CI status in the [Actions tab](https://github.com/modelscope/modelscope-mcp-server/actions).
182187

183188
## 📦 Release Management
184189

185-
This project uses GitHub Actions for automated release management.
190+
This project uses GitHub Actions for automated release management. To create a new release:
191+
192+
1. **Update version** using the bump script:
193+
194+
```bash
195+
uv run python scripts/bump_version.py [patch|minor|major]
196+
# Or set specific version: uv run python scripts/bump_version.py set 1.2.3.dev1
197+
```
198+
199+
2. **Commit and tag** (follow the script's output instructions):
200+
201+
```bash
202+
git add src/modelscope_mcp_server/_version.py
203+
git commit -m "chore: bump version to v{version}"
204+
git tag v{version} && git push origin v{version}
205+
```
206+
207+
3. **Automated publishing** - GitHub Actions will automatically:
208+
- Create a new [GitHub Release](https://github.com/modelscope/modelscope-mcp-server/releases)
209+
- Publish package to [PyPI repository](https://pypi.org/project/modelscope-mcp-server/)
210+
- Build and push Docker image to [GitHub Container Registry](https://github.com/modelscope/modelscope-mcp-server/pkgs/container/modelscope-mcp-server)
186211

187212
## 🤝 Contributing
188213

189-
We welcome contributions! Please ensure that:
214+
We welcome contributions! Please ensure your PRs:
190215

191-
1. All PRs include relevant tests and pass the full test suite
192-
2. Code follows our style guidelines (enforced by pre-commit hooks)
193-
3. Documentation is updated for new features
194-
4. Commit messages follow conventional commit format
216+
- Include relevant tests and pass all CI checks
217+
- Update documentation for new features
218+
- Follow conventional commit format
195219

196220
## 📚 References
197221

0 commit comments

Comments
 (0)