Skip to content

Commit 39870a9

Browse files
committed
Merge branch 'develop' into feat-timeout
2 parents db25c09 + c8f36ab commit 39870a9

File tree

3 files changed

+107
-3
lines changed

3 files changed

+107
-3
lines changed

.github/workflows/publish.yml

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
name: Publish
2+
on:
3+
push:
4+
branches: [main]
5+
strategy:
6+
matrix:
7+
python-version: ["3.11"]
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
15+
- name: Set up Python ${{ matrix.python-version }}
16+
uses: actions/setup-python@v5
17+
with:
18+
python-version: ${{ matrix.python-version }}
19+
20+
- name: Install uv
21+
run: |
22+
python -m pip install --upgrade pip
23+
pip install uv
24+
25+
- name: Install dev/test dependencies
26+
run: |
27+
pip install -e ".[dev]"
28+
pip install -e ".[test]"
29+
30+
- name: Run tests
31+
run: |
32+
uv run pytest
33+
34+
- name: Run ruff
35+
run: |
36+
uv run ruff check .
37+
38+
- name: Run black
39+
run: |
40+
uv run black . --check
41+
42+
- name: Run isort
43+
run: |
44+
uv run isort . --check-only
45+
46+
- name: Run mypy
47+
run: |
48+
uv run mypy mcp_shell_server tests
49+
50+
publish:
51+
needs: test
52+
runs-on: ubuntu-latest
53+
environment: release
54+
permissions:
55+
id-token: write
56+
57+
steps:
58+
- uses: actions/checkout@v4
59+
60+
- name: Set up Python ${{ matrix.python-version }}
61+
uses: actions/setup-python@v5
62+
with:
63+
python-version: ${{ matrix.python-version }}
64+
65+
- name: Install uv
66+
run: |
67+
python -m pip install --upgrade pip
68+
pip install uv
69+
70+
- name: Build package
71+
run: |
72+
uv build
73+
74+
- name: Publish to PyPI
75+
env:
76+
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
77+
run: |
78+
uv publish --token $PYPI_TOKEN

.github/workflows/test.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@ name: Test
22

33
on:
44
push:
5-
branches: [main]
5+
branches: [main, develop]
66
pull_request:
7-
branches: [main]
7+
branches: [main, develop]
88

99
jobs:
1010
test:

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,32 @@ A secure shell command execution server implementing the Model Context Protocol
1212

1313
## MCP client setting in your Claude.app
1414

15+
### Published version
16+
17+
```shell
18+
code ~/Library/Application\ Support/Claude/claude_desktop_config.json
19+
```
20+
21+
```json
22+
{
23+
"mcpServers": {
24+
"shell": {
25+
"command": "uvx",
26+
"args": [
27+
"mcp-shell-server"
28+
],
29+
"env": {
30+
"ALLOW_COMMANDS": "ls,cat,pwd,grep,wc,touch,find"
31+
}
32+
},
33+
}
34+
}
35+
```
36+
37+
### Local version
38+
39+
#### Configuration
40+
1541
```shell
1642
code ~/Library/Application\ Support/Claude/claude_desktop_config.json
1743
```
@@ -35,7 +61,7 @@ code ~/Library/Application\ Support/Claude/claude_desktop_config.json
3561
}
3662
```
3763

38-
## Installation
64+
#### Installation
3965

4066
```bash
4167
pip install mcp-shell-server

0 commit comments

Comments
 (0)