swanlab-mcp 0.0.1__tar.gz

swanlab_mcp-0.0.1/.env.template

@@ -0,0 +1 @@
+SWANLAB_API_KEY=<you_api_key>

swanlab_mcp-0.0.1/.github/workflows/python-publish.yml

@@ -0,0 +1,39 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+
+      - name: Sync Dependencies
+        run: uv sync
+
+      - name: Build Package
+        run: uv build
+
+      - name: Publish to PyPI
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
+        run: uv publish
+
+      - run: cp dist/*.whl .
+
+      - name: Release
+        uses: softprops/action-gh-release@v2
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          files: |
+            *.whl

swanlab_mcp-0.0.1/.gitignore

@@ -0,0 +1,51 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+
+# IDEs and editors
+.vscode/
+.idea/
+
+
+# macOS
+.DS_Store
+
+# Logs and databases
+*.log
+*.sqlite3
+
+# linters and formatters
+.ropeproject/
+.mypy_cache/
+.pytest_cache/
+.coverage
+htmlcov/
+*ruff_cache/
+
+# playground
+playground/
+
+
+# settings
+.claude/*
+.cursor/*
+
+
+# AI agents
+AGENTS.md
+GEMINI.md
+CLAUDE.md
+IFLOW.md
+QWEN.md
+
+# env
+.env
+uv.lock

swanlab_mcp-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+repos:
+  - repo: local
+    hooks:
+      - id: make-format
+        name: make format
+        entry: make format
+        language: system
+        pass_filenames: false
+        always_run: true
+
+      - id: commit-msg
+        name: commit msg check
+        entry: scripts/commit-msg-check.sh
+        language: script
+        stages: [commit-msg]
+        always_run: true

swanlab_mcp-0.0.1/.python-version

@@ -0,0 +1 @@
+3.12

swanlab_mcp-0.0.1/Makefile

@@ -0,0 +1,5 @@
+.PHONY: format
+
+format:
+	-uvx isort . --skip-gitignore
+	-uvx ruff format . --quiet

swanlab_mcp-0.0.1/PKG-INFO

@@ -0,0 +1,155 @@
+Metadata-Version: 2.4
+Name: swanlab-mcp
+Version: 0.0.1
+Summary: MCP (Model Context Protocol) server support for SwanLab
+Author-email: CaddiesNew <nexisato0810@gmail.com>
+License: MIT
+Requires-Python: >=3.12
+Requires-Dist: fastmcp>=2.14.4
+Requires-Dist: pydantic-settings>=2.0.0
+Requires-Dist: python-dotenv>=1.2.1
+Requires-Dist: swanlab
+Description-Content-Type: text/markdown
+
+# SwanLab-MCP-Server
+
+> A Model Context Protocol (MCP) server implementation for SwanLab, combining SwanLab-OpenAPI & FastMCP.
+
+## ✨ Features
+
+### Core Features
+
+- **Workspace Management** - List and manage user-accessible workspaces
+- **Project Management** - Create, retrieve, delete projects, and list project information
+- **Experiment Management** - Create, retrieve, delete experiments, and retrieve experiment metrics and summaries
+- **API Integration** - Provide complete platform access through SwanLab OpenAPI
+
+### Tech Stack
+
+- **Language**: Python 3.12+
+- **Core Framework**: FastMCP (v2.14.4+)
+- **API Client**: SwanLab SDK
+- **Config Management**: Pydantic Settings
+
+## 🚀 Quick Start
+
+### ❗️Configuration
+
+Add the following configuration to your relative mcp config list
+
+```json
+{
+  "mcpServers": 
+    ...
+    {
+    "swanlab-mcp": {
+      "command": "uv",
+      "args": ["run", "swanlab_mcp", "--transport", "stdio"],
+      "env": {
+        "SWANLAB_API_KEY": "your_api_key_here"
+      }
+    }
+  }
+}
+```
+
+For `Claude Code` Users, you can config like this:
+
+```bash
+claude mcp add --env SWANLAB_API_KEY=<your_api_key> -- swanlab_mcp uv run swanlab_mcp --transport stdio
+```
+
+### Prerequisites
+
+- Python >= 3.12
+- SwanLab API Key (get it from [SwanLab](https://swanlab.cn))
+
+### Installation
+
+```bash
+# Using uv (recommended)
+uv sync
+
+# Or using pip
+pip install -e .
+```
+
+### Configuration
+
+#### Environment Variables
+
+Create a `.env` file and configure your API key:
+
+```bash
+cp .env.template .env
+```
+
+Edit the `.env` file:
+
+```env
+SWANLAB_API_KEY=your_api_key_here
+```
+
+### Running
+
+```bash
+# Using stdio transport (default)
+python -m swanlab_mcp
+
+# Or using CLI
+python -m swanlab_mcp --transport stdio
+
+# Check version
+python -m swanlab_mcp --version
+```
+
+### Usage
+
+After configuration, restart Claude Desktop to interact with SwanLab via the MCP protocol.
+
+Available Tools:
+- `swanlab_list_workspaces` - List workspaces
+- `swanlab_create_project` - Create project
+- `swanlab_list_projects` - List projects
+- `swanlab_create_experiment` - Create experiment
+- `swanlab_list_experiments` - List experiments
+- `swanlab_get_experiment` - Get experiment details
+- `swanlab_delete_experiment` - Delete experiment
+
+## 🛠️ Development
+
+### Code Formatting
+
+```bash
+# Using Makefile
+make format
+
+# Or manually
+uvx isort . --skip-gitignore
+uvx ruff format . --quiet
+```
+
+### Lint Check
+
+```bash
+uvx ruff check .
+```
+
+### Pre-commit Hooks
+
+```bash
+bash scripts/install-hooks.sh
+```
+
+## 📚 References & Acknowledgements
+
+- [SwanLab](https://github.com/SwanHubX/SwanLab)
+- [Model Context Protocol](https://modelcontextprotocol.io/docs/getting-started/intro)
+- [FastMCP v2](https://github.com/jlowin/fastmcp)
+- [modelscope-mcp-server](https://github.com/modelscope/modelscope-mcp-server)
+- [TrackIO-mcp-server](https://github.com/fcakyon/trackio-mcp)
+- [Simple-Wandb-mcp-server](https://github.com/tsilva/simple-wandb-mcp-server)
+
+## 📄 License
+
+MIT License

swanlab_mcp-0.0.1/README.md

@@ -0,0 +1,142 @@
+# SwanLab-MCP-Server
+
+> A Model Context Protocol (MCP) server implementation for SwanLab, combining SwanLab-OpenAPI & FastMCP.
+
+## ✨ Features
+
+### Core Features
+
+- **Workspace Management** - List and manage user-accessible workspaces
+- **Project Management** - Create, retrieve, delete projects, and list project information
+- **Experiment Management** - Create, retrieve, delete experiments, and retrieve experiment metrics and summaries
+- **API Integration** - Provide complete platform access through SwanLab OpenAPI
+
+### Tech Stack
+
+- **Language**: Python 3.12+
+- **Core Framework**: FastMCP (v2.14.4+)
+- **API Client**: SwanLab SDK
+- **Config Management**: Pydantic Settings
+
+## 🚀 Quick Start
+
+### ❗️Configuration
+
+Add the following configuration to your relative mcp config list
+
+```json
+{
+  "mcpServers": 
+    ...
+    {
+    "swanlab-mcp": {
+      "command": "uv",
+      "args": ["run", "swanlab_mcp", "--transport", "stdio"],
+      "env": {
+        "SWANLAB_API_KEY": "your_api_key_here"
+      }
+    }
+  }
+}
+```
+
+For `Claude Code` Users, you can config like this:
+
+```bash
+claude mcp add --env SWANLAB_API_KEY=<your_api_key> -- swanlab_mcp uv run swanlab_mcp --transport stdio
+```
+
+### Prerequisites
+
+- Python >= 3.12
+- SwanLab API Key (get it from [SwanLab](https://swanlab.cn))
+
+### Installation
+
+```bash
+# Using uv (recommended)
+uv sync
+
+# Or using pip
+pip install -e .
+```
+
+### Configuration
+
+#### Environment Variables
+
+Create a `.env` file and configure your API key:
+
+```bash
+cp .env.template .env
+```
+
+Edit the `.env` file:
+
+```env
+SWANLAB_API_KEY=your_api_key_here
+```
+
+### Running
+
+```bash
+# Using stdio transport (default)
+python -m swanlab_mcp
+
+# Or using CLI
+python -m swanlab_mcp --transport stdio
+
+# Check version
+python -m swanlab_mcp --version
+```
+
+### Usage
+
+After configuration, restart Claude Desktop to interact with SwanLab via the MCP protocol.
+
+Available Tools:
+- `swanlab_list_workspaces` - List workspaces
+- `swanlab_create_project` - Create project
+- `swanlab_list_projects` - List projects
+- `swanlab_create_experiment` - Create experiment
+- `swanlab_list_experiments` - List experiments
+- `swanlab_get_experiment` - Get experiment details
+- `swanlab_delete_experiment` - Delete experiment
+
+## 🛠️ Development
+
+### Code Formatting
+
+```bash
+# Using Makefile
+make format
+
+# Or manually
+uvx isort . --skip-gitignore
+uvx ruff format . --quiet
+```
+
+### Lint Check
+
+```bash
+uvx ruff check .
+```
+
+### Pre-commit Hooks
+
+```bash
+bash scripts/install-hooks.sh
+```
+
+## 📚 References & Acknowledgements
+
+- [SwanLab](https://github.com/SwanHubX/SwanLab)
+- [Model Context Protocol](https://modelcontextprotocol.io/docs/getting-started/intro)
+- [FastMCP v2](https://github.com/jlowin/fastmcp)
+- [modelscope-mcp-server](https://github.com/modelscope/modelscope-mcp-server)
+- [TrackIO-mcp-server](https://github.com/fcakyon/trackio-mcp)
+- [Simple-Wandb-mcp-server](https://github.com/tsilva/simple-wandb-mcp-server)
+
+## 📄 License
+
+MIT License

swanlab_mcp-0.0.1/README_zh.md

@@ -0,0 +1,142 @@
+# SwanLab-MCP-Server
+
+> SwanLab-MCP-Server 是一个基于 Python 的 MCP（Model Context Protocol）服务器实现，结合了 SwanLab-OpenAPI 和 FastMCP 框架。
+
+## ✨ 功能特性
+
+### 核心功能
+
+- **工作空间管理** - 列出和管理用户可访问的工作空间
+- **项目管理** - 创建、获取、删除项目，以及列出项目信息
+- **实验管理** - 创建、获取、删除实验，检索实验指标和摘要
+- **API 集成** - 通过 SwanLab OpenAPI 提供完整的平台访问能力
+
+### 技术栈
+
+- **语言**: Python 3.12+
+- **核心框架**: FastMCP (v2.14.4+)
+- **API 客户端**: SwanLab SDK
+- **配置管理**: Pydantic Settings
+
+## 🚀 快速开始
+
+
+### ❗️重要【配置方式】
+
+在你对应的 mcp 配置文件中赋值如下配置 (如 `cursor`, `claude code`, 或许也可以手动实现？) 
+
+```json
+{
+  "mcpServers": 
+    ...
+    {
+    "swanlab-mcp": {
+      "command": "uvx",
+      "args": ["swanlab_mcp", "--transport", "stdio"],
+      "env": {
+        "SWANLAB_API_KEY": "your_api_key_here"
+      }
+    }
+  }
+}
+```
+对于 `Claude Code` 用户，可以一次性配置：
+
+```bash
+claude mcp add --env SWANLAB_API_KEY=<your_api_key> -- swanlab_mcp uv run swanlab_mcp --transport stdio
+```
+
+### 环境要求
+
+- Python >= 3.12
+- SwanLab API Key（从 [SwanLab](https://swanlab.cn) 获取）
+
+### 安装
+
+```bash
+# 使用 uv 安装（推荐）
+uv sync
+
+# 或使用 pip
+pip install -e .
+```
+
+### 配置
+
+#### 环境变量
+
+创建 `.env` 文件并配置 API 密钥：
+
+```bash
+cp .env.template .env
+```
+
+编辑 `.env` 文件：
+
+```env
+SWANLAB_API_KEY=your_api_key_here
+```
+
+### 运行
+
+```bash
+# 使用 stdio 传输（默认）
+python -m swanlab_mcp
+
+# 或使用 CLI
+python -m swanlab_mcp --transport stdio
+
+# 查看版本
+python -m swanlab_mcp --version
+```
+
+### 使用
+
+配置完成后，重启 Claude Desktop，即可通过 MCP 协议与 SwanLab 进行交互。
+
+可用工具：
+- `swanlab_list_workspaces` - 列出工作空间
+- `swanlab_create_project` - 创建项目
+- `swanlab_list_projects` - 列出项目
+- `swanlab_create_experiment` - 创建实验
+- `swanlab_list_experiments` - 列出实验
+- `swanlab_get_experiment` - 获取实验详情
+- `swanlab_delete_experiment` - 删除实验
+
+## 🛠️ 开发
+
+### 代码格式化
+
+```bash
+# 使用 Makefile
+make format
+
+# 或手动执行
+uvx isort . --skip-gitignore
+uvx ruff format . --quiet
+```
+
+### Lint 检查
+
+```bash
+uvx ruff check .
+```
+
+### Pre-commit 钩子
+
+```bash
+bash scripts/install-hooks.sh
+```
+
+## 📚 参考资料
+
+- [SwanLab](https://github.com/SwanHubX/SwanLab)
+- [Model Context Protocol](https://modelcontextprotocol.io/docs/getting-started/intro)
+- [FastMCP v2](https://github.com/jlowin/fastmcp)
+- [modelscope-mcp-server](https://github.com/modelscope/modelscope-mcp-server)
+- [TrackIO-mcp-server](https://github.com/fcakyon/trackio-mcp)
+- [Simple-Wandb-mcp-server](https://github.com/tsilva/simple-wandb-mcp-server)
+
+## 📄 许可证
+
+MIT License

swanlab_mcp-0.0.1/pyproject.toml

@@ -0,0 +1,45 @@
+[project]
+name = "swanlab-mcp"
+dynamic = ["version"]
+description = "MCP (Model Context Protocol) server support for SwanLab"
+authors = [{ name = "CaddiesNew", email = "nexisato0810@gmail.com" }]
+license = { text = "MIT" }
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "fastmcp>=2.14.4",
+    "pydantic-settings>=2.0.0",
+    "python-dotenv>=1.2.1",
+    "swanlab",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/swanlab_mcp"]
+
+[project.scripts]
+swanlab_mcp = "swanlab_mcp.cli:main"
+
+[dependency-groups]
+dev = ["pre-commit>=4.3.0", "ruff>=0.14.3"]
+
+[tool.hatch.version]
+path = "src/swanlab_mcp/_version.py"
+
+
+[tool.ruff]
+line-length = 122
+target-version = "py312"
+include = ["**/*.py", "**/*.pyi"]
+src = ["src"]
+exclude = [".git", ".ruff_cache", ".venv", "__pycache__", "build", "dist"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["constants", "tools"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"