Skip to content

Commit 83df1b2

Browse files
committed
Cleanup and lint
Signed-off-by: Mihai Criveti <[email protected]>
1 parent 8c5e392 commit 83df1b2

File tree

4 files changed

+28
-30
lines changed

4 files changed

+28
-30
lines changed

.github/workflows/snyk.yml.inactive

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ jobs:
6060
dependencies:
6161
name: 📦 Dependency Scan
6262
runs-on: ubuntu-latest
63-
63+
6464
steps:
6565
# -------------------------------------------------------------
6666
# 0️⃣ Checkout source
@@ -108,7 +108,7 @@ jobs:
108108
code-security:
109109
name: 🔐 Code Security (SAST)
110110
runs-on: ubuntu-latest
111-
111+
112112
steps:
113113
# -------------------------------------------------------------
114114
# 0️⃣ Checkout source
@@ -163,7 +163,7 @@ jobs:
163163
container-security:
164164
name: 🐳 Container Security
165165
runs-on: ubuntu-latest
166-
166+
167167
steps:
168168
# -------------------------------------------------------------
169169
# 0️⃣ Checkout source
@@ -223,7 +223,7 @@ jobs:
223223
iac-security:
224224
name: 🏗️ IaC Security
225225
runs-on: ubuntu-latest
226-
226+
227227
steps:
228228
# -------------------------------------------------------------
229229
# 0️⃣ Checkout source
@@ -253,7 +253,7 @@ jobs:
253253
--json-file-output="snyk-iac-${file%.y*ml}.json" || true
254254
fi
255255
done
256-
256+
257257
# Test Containerfiles
258258
for file in Containerfile*; do
259259
if [ -f "$file" ]; then
@@ -308,7 +308,7 @@ jobs:
308308
name: 📋 Generate SBOM
309309
runs-on: ubuntu-latest
310310
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
311-
311+
312312
steps:
313313
# -------------------------------------------------------------
314314
# 0️⃣ Checkout source
@@ -337,7 +337,7 @@ jobs:
337337
run: |
338338
# Get version from pyproject.toml
339339
VERSION=$(grep -m1 version pyproject.toml | cut -d'"' -f2 || echo "0.0.0")
340-
340+
341341
# Generate CycloneDX format
342342
snyk sbom \
343343
--format=cyclonedx1.5+json \
@@ -346,7 +346,7 @@ jobs:
346346
--version=$VERSION \
347347
--json-file-output=sbom-cyclonedx.json \
348348
. || true
349-
349+
350350
# Generate SPDX format
351351
snyk sbom \
352352
--format=spdx2.3+json \
@@ -376,7 +376,7 @@ jobs:
376376
runs-on: ubuntu-latest
377377
needs: [dependencies, code-security, container-security, iac-security]
378378
if: always()
379-
379+
380380
steps:
381381
# -------------------------------------------------------------
382382
# 0️⃣ Download all artifacts
@@ -397,16 +397,16 @@ jobs:
397397
echo "**Triggered by:** ${{ github.event_name }}" >> $GITHUB_STEP_SUMMARY
398398
echo "**Severity Threshold:** ${{ github.event.inputs.severity-threshold || 'high' }}" >> $GITHUB_STEP_SUMMARY
399399
echo "" >> $GITHUB_STEP_SUMMARY
400-
400+
401401
echo "## 📋 Scan Results" >> $GITHUB_STEP_SUMMARY
402402
echo "" >> $GITHUB_STEP_SUMMARY
403-
403+
404404
# List all result files
405405
echo "### 📁 Generated Reports:" >> $GITHUB_STEP_SUMMARY
406406
find snyk-results -type f -name "*.json" -o -name "*.sarif" | while read -r file; do
407407
echo "- \`$(basename "$file")\`" >> $GITHUB_STEP_SUMMARY
408408
done
409-
409+
410410
echo "" >> $GITHUB_STEP_SUMMARY
411411
echo "---" >> $GITHUB_STEP_SUMMARY
412-
echo "*View detailed results in the [Security tab](../../security/code-scanning) or download artifacts from this workflow run.*" >> $GITHUB_STEP_SUMMARY
412+
echo "*View detailed results in the [Security tab](../../security/code-scanning) or download artifacts from this workflow run.*" >> $GITHUB_STEP_SUMMARY

docker-compose.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -396,4 +396,3 @@ services:
396396
# timeout: 10s
397397
# retries: 5
398398
# start_period: 20s
399-

docs/docs/best-practices/mcp-best-practices.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -106,19 +106,19 @@ time_server/
106106
├── .gitignore # Exclude venvs, artifacts, and secrets from Git
107107
├── docs/ # (Optional) Diagrams, specs, and additional documentation
108108
├── tests/ # Unit and integration tests
109-
   ├── __init__.py
110-
   ├── test_main.py # Tests for main entrypoint behavior
111-
   └── test_tools.py # Tests for core tool functionality
109+
├── __init__.py
110+
├── test_main.py # Tests for main entrypoint behavior
111+
└── test_tools.py # Tests for core tool functionality
112112
└── src/ # Application source code
113-
   └── mcp_time_server/ # Main package named after your server
114-
   ├── __init__.py # Marks this directory as a Python package
115-
   ├── main.py # Entrypoint that wires everything together
116-
   ├── mcp_server_base.py # Optional base class for shared server behavior
117-
   ├── server.py # Server logic (e.g., tool registration, lifecycle hooks)
118-
   └── tools/ # Directory for all MCP tool implementations
119-
   ├── __init__.py
120-
   ├── tools.py # Tool business logic (e.g., `get_time`, `format_time`)
121-
   └── tools_registration.py # Registers tools into the MCP framework
113+
└── mcp_time_server/ # Main package named after your server
114+
├── __init__.py # Marks this directory as a Python package
115+
├── main.py # Entrypoint that wires everything together
116+
├── mcp_server_base.py # Optional base class for shared server behavior
117+
├── server.py # Server logic (e.g., tool registration, lifecycle hooks)
118+
└── tools/ # Directory for all MCP tool implementations
119+
├── __init__.py
120+
├── tools.py # Tool business logic (e.g., `get_time`, `format_time`)
121+
└── tools_registration.py # Registers tools into the MCP framework
122122
```
123123

124124
## 📝 Documentation
@@ -165,7 +165,7 @@ MCP_GITHUB_BASE_URL=...
165165

166166
## 🏷 Required Capabilities (README Metadata Tags)
167167

168-
Add tags at the top of `README.md` between YAML markers to declare your servers required capabilities.
168+
Add tags at the top of `README.md` between YAML markers to declare your server's required capabilities.
169169

170170
### Available Tags:
171171

@@ -195,4 +195,4 @@ tags:
195195
- needs_filesystem_access
196196
- needs_api_key_user
197197
---
198-
```
198+
```

tests/unit/mcpgateway/services/test_gateway_service.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,6 @@ async def test_ssl_verification_bypass(self, gateway_service, monkeypatch):
278278
Test case logic to verify settings.skip_ssl_verify
279279
280280
"""
281-
pass
282281

283282
# ────────────────────────────────────────────────────────────────────
284283
# Validate Gateway URL Auth Failure - 401
@@ -433,7 +432,7 @@ async def test_bulk_concurrent_validation(self, gateway_service, monkeypatch):
433432
resilient_client_mock.client = mock_client
434433
resilient_client_mock.aclose = AsyncMock()
435434

436-
# Patch ResilientHttpClient where its used in your module
435+
# Patch ResilientHttpClient where it's used in your module
437436
monkeypatch.setattr("mcpgateway.services.gateway_service.ResilientHttpClient", MagicMock(return_value=resilient_client_mock))
438437

439438
# Run the validations concurrently

0 commit comments

Comments
 (0)