yapi-mcp 0.1.0__tar.gz → 0.1.2__tar.gz

{yapi_mcp-0.1.0 → yapi_mcp-0.1.2}/.gitignore

@@ -1,53 +1,56 @@
-# Python
-__pycache__/
-*.py[cod]
-*$py.class
-*.so
-.Python
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-MANIFEST
-
-# Virtual environments
-venv/
-ENV/
-env/
-.venv
-
-# Testing
-.pytest_cache/
-.coverage
-htmlcov/
-.tox/
-.hypothesis/
-
-# IDEs
-.vscode/
-.idea/
-*.swp
-*.swo
-*~
-
-# Environment variables (NEVER commit credentials!)
-.env
-
-# OS files
-.DS_Store
-Thumbs.db
-
-# MCP specific
-fastmcp.json
-*.log
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Virtual environments
+venv/
+ENV/
+env/
+.venv
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+.hypothesis/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# Environment variables (NEVER commit credentials!)
+.env
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# MCP specific
+fastmcp.json
+*.log
+
+pypi-token.txt
+.ace-tool/

{yapi_mcp-0.1.0 → yapi_mcp-0.1.2}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 YApi MCP Server Contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2025 YApi MCP Server Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

yapi_mcp-0.1.2/PKG-INFO

@@ -0,0 +1,174 @@
+Metadata-Version: 2.4
+Name: yapi-mcp
+Version: 0.1.2
+Summary: Model Context Protocol server for YApi 1.12.0 API management platform
+Project-URL: Homepage, https://github.com/geq1fan/yapi-mcp
+Project-URL: Repository, https://github.com/geq1fan/yapi-mcp
+Project-URL: Issues, https://github.com/geq1fan/yapi-mcp/issues
+Author: YApi MCP Team
+License: MIT
+License-File: LICENSE
+Keywords: api,fastmcp,mcp,model-context-protocol,yapi
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.11
+Requires-Dist: fastmcp>=2.0.0
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: pydantic-settings>=2.0.0
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: respx>=0.21.0; extra == 'dev'
+Requires-Dist: ruff>=0.4.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# YApi MCP Server
+
+[![Python Version](https://img.shields.io/badge/python-3.11%2B-blue)](https://www.python.org/downloads/)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+
+基于 [YApi 1.12.0](https://github.com/YMFE/yapi) 接口管理平台的 Model Context Protocol (MCP) 服务器。
+
+使开发者能够在支持 MCP 的 IDE 和编辑器(Claude Code、Cursor 等)中直接搜索、查看、创建和更新 YApi 接口定义,无需离开开发环境。
+
+## 功能特性
+
+- 🔍 **搜索接口**: 通过标题、路径或描述查找 API 端点
+- 📖 **查看定义**: 获取完整的接口规范,包括请求/响应结构
+- ➕ **创建接口**: 向 YApi 项目添加新的 API 定义
+- ✏️ **更新接口**: 修改现有接口配置
+- 🔐 **Cookie 认证**: 基于会话的安全认证
+- ⚡ **异步性能**: 基于 httpx 实现高效的并发操作
+
+## 环境要求
+
+- Python 3.11 或更高版本
+- YApi 1.12.0 实例(可通过 HTTP/HTTPS 访问)
+- 有效的 YApi 认证 cookies
+
+## 配置
+
+### 1. 获取 YApi Cookies
+
+1. 在浏览器中登录 YApi 实例
+2. 打开开发者工具(F12)
+3. 导航到 **Application** → **Cookies**(Chrome) 或 **Storage** → **Cookies**(Firefox)
+4. 复制以下 cookie 值:
+   - `_yapi_token` (必需)
+   - `_yapi_uid` (必需)
+   - `ZYBIPSCAS` (可选，仅某些自定义部署需要)
+
+### 2. 配置 MCP
+
+```json
+{
+  "mcpServers": {
+    "yapi": {
+      "command": "uvx",
+      "args": ["--from", "/path/to/yapi-mcp", "yapi-mcp"],
+      "env": {
+        "YAPI_SERVER_URL": "https://your-yapi-instance.com",
+        "YAPI_TOKEN": "your_token",
+        "YAPI_UID": "your_uid"
+      }
+    }
+  }
+}
+```
+
+> **注意**: 如果你的 YApi 部署需要额外的 CAS 认证，添加 `"YAPI_CAS": "your_cas_value"` 到 `env` 中。
+
+## 开发
+
+### 运行测试
+
+```bash
+# 安装开发依赖
+pip install -e ".[dev]"
+
+# 运行所有测试
+pytest
+
+# 运行并显示覆盖率
+pytest --cov=src --cov-report=term-missing
+
+# 运行特定测试文件
+pytest tests/test_config.py
+```
+
+### 代码质量
+
+```bash
+# 格式化代码
+ruff format
+
+# 代码检查
+ruff check
+
+# 自动修复检查问题
+ruff check --fix
+```
+
+### 项目结构
+
+```
+yapi-mcp/
+├── src/
+│   ├── server.py          # MCP 服务器入口点
+│   ├── config.py          # 配置模型
+│   ├── yapi/
+│   │   ├── client.py      # YApi API 客户端
+│   │   ├── models.py      # Pydantic 数据模型
+│   │   └── errors.py      # 错误映射
+│   └── tools/             # MCP 工具(在 server.py 中注册)
+├── tests/                 # 测试套件
+├── specs/                 # 设计文档
+├── pyproject.toml         # 项目配置
+├── .env.example           # 环境变量模板
+└── README.md              # 本文件
+```
+
+## 贡献
+
+欢迎贡献! 我们非常感谢各种形式的贡献,包括但不限于:
+
+- 🐛 报告 Bug
+- ✨ 建议新功能
+- 📝 改进文档
+- 💻 提交代码
+
+在开始贡献之前,请阅读我们的[贡献指南](CONTRIBUTING.md)。
+
+### 快速开始
+
+1. Fork 本仓库
+2. 创建功能分支 (`git checkout -b feature/amazing-feature`)
+3. 提交更改 (`git commit -m 'feat: 添加惊人的功能'`)
+4. 推送到分支 (`git push origin feature/amazing-feature`)
+5. 创建 Pull Request
+
+### 代码质量要求
+
+- ✅ 所有测试通过: `pytest`
+- ✅ 代码已格式化: `ruff format`
+- ✅ 无检查错误: `ruff check`
+- ✅ 新功能包含测试
+
+详细信息请参阅 [CONTRIBUTING.md](CONTRIBUTING.md)。
+
+## 许可证
+
+本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。
+
+## 相关项目
+
+- [YApi](https://github.com/YMFE/yapi) - API 管理平台
+- [fastmcp](https://github.com/jlowin/fastmcp) - Python MCP 框架
+- [Model Context Protocol](https://modelcontextprotocol.io/) - MCP 规范

yapi_mcp-0.1.2/README.md

@@ -0,0 +1,144 @@
+# YApi MCP Server
+
+[![Python Version](https://img.shields.io/badge/python-3.11%2B-blue)](https://www.python.org/downloads/)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+
+基于 [YApi 1.12.0](https://github.com/YMFE/yapi) 接口管理平台的 Model Context Protocol (MCP) 服务器。
+
+使开发者能够在支持 MCP 的 IDE 和编辑器(Claude Code、Cursor 等)中直接搜索、查看、创建和更新 YApi 接口定义,无需离开开发环境。
+
+## 功能特性
+
+- 🔍 **搜索接口**: 通过标题、路径或描述查找 API 端点
+- 📖 **查看定义**: 获取完整的接口规范,包括请求/响应结构
+- ➕ **创建接口**: 向 YApi 项目添加新的 API 定义
+- ✏️ **更新接口**: 修改现有接口配置
+- 🔐 **Cookie 认证**: 基于会话的安全认证
+- ⚡ **异步性能**: 基于 httpx 实现高效的并发操作
+
+## 环境要求
+
+- Python 3.11 或更高版本
+- YApi 1.12.0 实例(可通过 HTTP/HTTPS 访问)
+- 有效的 YApi 认证 cookies
+
+## 配置
+
+### 1. 获取 YApi Cookies
+
+1. 在浏览器中登录 YApi 实例
+2. 打开开发者工具(F12)
+3. 导航到 **Application** → **Cookies**(Chrome) 或 **Storage** → **Cookies**(Firefox)
+4. 复制以下 cookie 值:
+   - `_yapi_token` (必需)
+   - `_yapi_uid` (必需)
+   - `ZYBIPSCAS` (可选，仅某些自定义部署需要)
+
+### 2. 配置 MCP
+
+```json
+{
+  "mcpServers": {
+    "yapi": {
+      "command": "uvx",
+      "args": ["--from", "/path/to/yapi-mcp", "yapi-mcp"],
+      "env": {
+        "YAPI_SERVER_URL": "https://your-yapi-instance.com",
+        "YAPI_TOKEN": "your_token",
+        "YAPI_UID": "your_uid"
+      }
+    }
+  }
+}
+```
+
+> **注意**: 如果你的 YApi 部署需要额外的 CAS 认证，添加 `"YAPI_CAS": "your_cas_value"` 到 `env` 中。
+
+## 开发
+
+### 运行测试
+
+```bash
+# 安装开发依赖
+pip install -e ".[dev]"
+
+# 运行所有测试
+pytest
+
+# 运行并显示覆盖率
+pytest --cov=src --cov-report=term-missing
+
+# 运行特定测试文件
+pytest tests/test_config.py
+```
+
+### 代码质量
+
+```bash
+# 格式化代码
+ruff format
+
+# 代码检查
+ruff check
+
+# 自动修复检查问题
+ruff check --fix
+```
+
+### 项目结构
+
+```
+yapi-mcp/
+├── src/
+│   ├── server.py          # MCP 服务器入口点
+│   ├── config.py          # 配置模型
+│   ├── yapi/
+│   │   ├── client.py      # YApi API 客户端
+│   │   ├── models.py      # Pydantic 数据模型
+│   │   └── errors.py      # 错误映射
+│   └── tools/             # MCP 工具(在 server.py 中注册)
+├── tests/                 # 测试套件
+├── specs/                 # 设计文档
+├── pyproject.toml         # 项目配置
+├── .env.example           # 环境变量模板
+└── README.md              # 本文件
+```
+
+## 贡献
+
+欢迎贡献! 我们非常感谢各种形式的贡献,包括但不限于:
+
+- 🐛 报告 Bug
+- ✨ 建议新功能
+- 📝 改进文档
+- 💻 提交代码
+
+在开始贡献之前,请阅读我们的[贡献指南](CONTRIBUTING.md)。
+
+### 快速开始
+
+1. Fork 本仓库
+2. 创建功能分支 (`git checkout -b feature/amazing-feature`)
+3. 提交更改 (`git commit -m 'feat: 添加惊人的功能'`)
+4. 推送到分支 (`git push origin feature/amazing-feature`)
+5. 创建 Pull Request
+
+### 代码质量要求
+
+- ✅ 所有测试通过: `pytest`
+- ✅ 代码已格式化: `ruff format`
+- ✅ 无检查错误: `ruff check`
+- ✅ 新功能包含测试
+
+详细信息请参阅 [CONTRIBUTING.md](CONTRIBUTING.md)。
+
+## 许可证
+
+本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。
+
+## 相关项目
+
+- [YApi](https://github.com/YMFE/yapi) - API 管理平台
+- [fastmcp](https://github.com/jlowin/fastmcp) - Python MCP 框架
+- [Model Context Protocol](https://modelcontextprotocol.io/) - MCP 规范

{yapi_mcp-0.1.0 → yapi_mcp-0.1.2}/pyproject.toml

@@ -1,52 +1,69 @@
-[project]
-name = "yapi-mcp"
-version = "0.1.0"
-description = "Model Context Protocol server for YApi 1.12.0 API management platform"
-authors = [{ name = "YApi MCP Team" }]
-readme = "README.md"
-requires-python = ">=3.11"
-dependencies = [
-    "fastmcp>=2.0.0",
-    "httpx>=0.27.0",
-    "pydantic-settings>=2.0.0",
-]
-
-[project.optional-dependencies]
-dev = [
-    "pytest>=8.0.0",
-    "pytest-asyncio>=0.23.0",
-    "respx>=0.21.0",
-    "ruff>=0.4.0",
-]
-
-[project.scripts]
-yapi-mcp = "server:main"
-
-[build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
-
-[tool.pytest.ini_options]
-asyncio_mode = "auto"
-testpaths = ["tests"]
-python_files = ["test_*.py"]
-python_classes = ["Test*"]
-python_functions = ["test_*"]
-
-[tool.ruff]
-line-length = 100
-target-version = "py311"
-
-[tool.ruff.lint]
-select = ["E", "F", "W", "I", "N", "UP", "ANN", "S", "B", "A", "C4", "DTZ", "T10", "EM", "ISC", "ICN", "G", "PIE", "T20", "PYI", "PT", "Q", "RSE", "RET", "SLF", "SIM", "TID", "TCH", "ARG", "PTH", "PD", "PGH", "PL", "TRY", "FLY", "NPY", "PERF", "RUF"]
-ignore = ["ANN101", "ANN102", "S101", "PLR0913"]
-
-[tool.ruff.format]
-quote-style = "double"
-indent-style = "space"
-
-[tool.hatch.build.targets.wheel]
-packages = ["src"]
-
-[tool.hatch.build.targets.wheel.sources]
-src = ""
+[project]
+name = "yapi-mcp"
+version = "0.1.2"
+description = "Model Context Protocol server for YApi 1.12.0 API management platform"
+authors = [{ name = "YApi MCP Team" }]
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.11"
+keywords = ["mcp", "yapi", "api", "model-context-protocol", "fastmcp"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "fastmcp>=2.0.0",
+    "httpx>=0.27.0",
+    "pydantic-settings>=2.0.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/geq1fan/yapi-mcp"
+Repository = "https://github.com/geq1fan/yapi-mcp"
+Issues = "https://github.com/geq1fan/yapi-mcp/issues"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0.0",
+    "pytest-asyncio>=0.23.0",
+    "respx>=0.21.0",
+    "ruff>=0.4.0",
+]
+
+[project.scripts]
+yapi-mcp = "yapi_mcp:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "N", "UP", "ANN", "S", "B", "A", "C4", "DTZ", "T10", "EM", "ISC", "ICN", "G", "PIE", "T20", "PYI", "PT", "Q", "RSE", "RET", "SLF", "SIM", "TID", "TCH", "ARG", "PTH", "PD", "PGH", "PL", "TRY", "FLY", "NPY", "PERF", "RUF"]
+ignore = ["ANN101", "ANN102", "S101", "PLR0913"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/yapi_mcp"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/yapi_mcp"]

yapi_mcp-0.1.2/src/yapi_mcp/__init__.py

@@ -0,0 +1,5 @@
+"""YApi MCP Server - Model Context Protocol adapter for YApi."""
+
+from yapi_mcp.server import main, mcp
+
+__all__ = ["main", "mcp"]

yapi_mcp-0.1.2/src/yapi_mcp/__main__.py

@@ -0,0 +1,6 @@
+"""Entry point for running yapi-mcp as a module: python -m yapi_mcp."""
+
+from yapi_mcp.server import main
+
+if __name__ == "__main__":
+    main()