llm-toolforge 0.3.0__tar.gz

llm_toolforge-0.3.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 kuon
+
+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.

llm_toolforge-0.3.0/PKG-INFO

@@ -0,0 +1,195 @@
+Metadata-Version: 2.4
+Name: llm-toolforge
+Version: 0.3.0
+Summary: LLM工具调用框架，同时提供 HTTP API 和 MCP Server 两种接入方式
+License: MIT License
+        
+        Copyright (c) 2026 kuon
+        
+        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.
+        
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi
+Requires-Dist: uvicorn
+Requires-Dist: aiofiles
+Requires-Dist: pydantic
+Requires-Dist: loguru
+Requires-Dist: pyyaml
+Requires-Dist: mcp[cli]
+Requires-Dist: tzdata
+Provides-Extra: ai
+Requires-Dist: openai; extra == "ai"
+Requires-Dist: volcengine-python-sdk[ark]; extra == "ai"
+Provides-Extra: aliyun
+Requires-Dist: oss2; extra == "aliyun"
+Provides-Extra: tencent
+Requires-Dist: cos-python-sdk-v5; extra == "tencent"
+Provides-Extra: mysql
+Requires-Dist: aiomysql; extra == "mysql"
+Provides-Extra: sqlite
+Requires-Dist: aiosqlite; extra == "sqlite"
+Provides-Extra: redis
+Requires-Dist: redis>=5.0; extra == "redis"
+Provides-Extra: all-storage
+Requires-Dist: llm-toolforge[aliyun,tencent]; extra == "all-storage"
+Provides-Extra: all-infra
+Requires-Dist: llm-toolforge[mysql,redis,sqlite]; extra == "all-infra"
+Provides-Extra: all
+Requires-Dist: llm-toolforge[ai,all-infra,all-storage]; extra == "all"
+Dynamic: license-file
+
+# llm-toolforge
+
+用语大模型的工具的框架，同时提供 **HTTP API**（FastAPI）和 **MCP Server**（SSE transport）两种接入方式。
+
+---
+
+## 快速开始
+
+### 安装框架
+
+```bash
+pip install llm-toolforge[all]
+
+# 如果是克隆的代码安装，则在根目录执行
+pip install -e ".[all]"
+
+# 验证
+toolforge --help
+```
+
+### 安装示例工具环境
+```bash
+cd examples
+pip install -r requirements.txt
+```
+
+* 编辑示例工具的配置文件
+```
+cp config.example.yaml config.yaml
+# 根据注释填写配置即可
+```
+
+* 运行：
+```bash
+toolforge run
+```
+打开页面`http://localhost:12345`进行测试。
+
+### 部署
+
+`toolforge new project` 会在项目目录下生成 `Dockerfile`
+
+```bash
+docker build -t llm-toolforge-example:v0.1.0 .
+
+docker run --rm \
+  -v "$(pwd)/config.yaml:/app/config.yaml" \
+  -e SERVICE_NAME=my-toolset \
+  -p 12345:12345 \
+  -p 12346:12346 \
+  llm-toolforge-example:v0.1.0
+```
+
+同一套基础设施（Redis / MySQL）跑多个 toolset 时，**必须**为每个 Deployment 设置唯一的 `SERVICE_NAME`，否则日志、统计、心跳会串在一起。
+
+**优先级：环境变量 > config.yaml**，两者都缺失时启动直接报错。
+
+**方式 1（推荐）：环境变量**
+
+```yaml
+env:
+  - name: SERVICE_NAME
+    value: my-toolset
+  - name: SERVICE_VERSION
+    value: v1.0.0
+```
+
+**方式 2：config.yaml**
+
+```yaml
+service:
+  name: my-toolset
+  version: v1.0.0
+```
+
+
+
+## 框架安装说明
+
+命令`llm-toolforge[all]`将会安装包含的所以组件
+```bash
+pip install llm-toolforge[all]
+```
+如果想指定组件，可以先安装基础核心
+```bash
+pip install llm-toolforge
+```
+然后根据需要安装下列依赖
+```bash
+# 日志后端（与 config.yaml 的 logging.storage 对应）
+pip install llm-toolforge[mysql]     # MySQL
+pip install llm-toolforge[sqlite]    # SQLite
+pip install llm-toolforge[redis]     # Redis（心跳 / 实时流 / 统计缓存）
+
+# AI 模型渠道
+pip install llm-toolforge[ai]        # 所有支持的 AI 渠道（OpenAI / 豆包 /千问）
+
+# 对象存储（工具上传文件时用）
+pip install llm-toolforge[aliyun]    # 阿里云 OSS
+pip install llm-toolforge[tencent]   # 腾讯云 COS
+```
+
+## 框架命令
+
+```bash
+toolforge run               # 启动 HTTP API + MCP 服务
+toolforge run --api-only    # 只起 HTTP API
+toolforge run --mcp-only    # 只起 MCP SSE
+toolforge list              # 列出已发现的工具
+toolforge new project .     # 初始化项目
+toolforge new tool <name>   # 生成工具骨架
+```
+
+
+---
+
+## 文档
+
+| 文档 | 内容 |
+|---|---|
+| [工具开发指南](docs/plugin-authoring.md) | 从零创建工具 + Generator / Plugin / InputField 完整说明 |
+| [接口参考](docs/api-reference.md) | HTTP API / MCP 协议 |
+| [部署指南](docs/deployment.md) | Docker / K8s / 多实例 |
+| [运行观测](docs/observability.md) | 日志 / 统计 / 负载监控 / 并发调优 |
+
+## 环境变量
+
+少量字段可由环境变量覆盖（**优先级高于 `config.yaml`**）：
+
+| 变量 | 覆盖字段 |
+|---|---|
+| `SERVICE_NAME` | `service.name` |
+| `SERVICE_VERSION` | `service.version` |
+
+K8s 多实例部署时推荐通过 Deployment 注入 `SERVICE_NAME`，避免镜像里写死。
+
+---

llm_toolforge-0.3.0/README.md

@@ -0,0 +1,137 @@
+# llm-toolforge
+
+用语大模型的工具的框架，同时提供 **HTTP API**（FastAPI）和 **MCP Server**（SSE transport）两种接入方式。
+
+---
+
+## 快速开始
+
+### 安装框架
+
+```bash
+pip install llm-toolforge[all]
+
+# 如果是克隆的代码安装，则在根目录执行
+pip install -e ".[all]"
+
+# 验证
+toolforge --help
+```
+
+### 安装示例工具环境
+```bash
+cd examples
+pip install -r requirements.txt
+```
+
+* 编辑示例工具的配置文件
+```
+cp config.example.yaml config.yaml
+# 根据注释填写配置即可
+```
+
+* 运行：
+```bash
+toolforge run
+```
+打开页面`http://localhost:12345`进行测试。
+
+### 部署
+
+`toolforge new project` 会在项目目录下生成 `Dockerfile`
+
+```bash
+docker build -t llm-toolforge-example:v0.1.0 .
+
+docker run --rm \
+  -v "$(pwd)/config.yaml:/app/config.yaml" \
+  -e SERVICE_NAME=my-toolset \
+  -p 12345:12345 \
+  -p 12346:12346 \
+  llm-toolforge-example:v0.1.0
+```
+
+同一套基础设施（Redis / MySQL）跑多个 toolset 时，**必须**为每个 Deployment 设置唯一的 `SERVICE_NAME`，否则日志、统计、心跳会串在一起。
+
+**优先级：环境变量 > config.yaml**，两者都缺失时启动直接报错。
+
+**方式 1（推荐）：环境变量**
+
+```yaml
+env:
+  - name: SERVICE_NAME
+    value: my-toolset
+  - name: SERVICE_VERSION
+    value: v1.0.0
+```
+
+**方式 2：config.yaml**
+
+```yaml
+service:
+  name: my-toolset
+  version: v1.0.0
+```
+
+
+
+## 框架安装说明
+
+命令`llm-toolforge[all]`将会安装包含的所以组件
+```bash
+pip install llm-toolforge[all]
+```
+如果想指定组件，可以先安装基础核心
+```bash
+pip install llm-toolforge
+```
+然后根据需要安装下列依赖
+```bash
+# 日志后端（与 config.yaml 的 logging.storage 对应）
+pip install llm-toolforge[mysql]     # MySQL
+pip install llm-toolforge[sqlite]    # SQLite
+pip install llm-toolforge[redis]     # Redis（心跳 / 实时流 / 统计缓存）
+
+# AI 模型渠道
+pip install llm-toolforge[ai]        # 所有支持的 AI 渠道（OpenAI / 豆包 /千问）
+
+# 对象存储（工具上传文件时用）
+pip install llm-toolforge[aliyun]    # 阿里云 OSS
+pip install llm-toolforge[tencent]   # 腾讯云 COS
+```
+
+## 框架命令
+
+```bash
+toolforge run               # 启动 HTTP API + MCP 服务
+toolforge run --api-only    # 只起 HTTP API
+toolforge run --mcp-only    # 只起 MCP SSE
+toolforge list              # 列出已发现的工具
+toolforge new project .     # 初始化项目
+toolforge new tool <name>   # 生成工具骨架
+```
+
+
+---
+
+## 文档
+
+| 文档 | 内容 |
+|---|---|
+| [工具开发指南](docs/plugin-authoring.md) | 从零创建工具 + Generator / Plugin / InputField 完整说明 |
+| [接口参考](docs/api-reference.md) | HTTP API / MCP 协议 |
+| [部署指南](docs/deployment.md) | Docker / K8s / 多实例 |
+| [运行观测](docs/observability.md) | 日志 / 统计 / 负载监控 / 并发调优 |
+
+## 环境变量
+
+少量字段可由环境变量覆盖（**优先级高于 `config.yaml`**）：
+
+| 变量 | 覆盖字段 |
+|---|---|
+| `SERVICE_NAME` | `service.name` |
+| `SERVICE_VERSION` | `service.version` |
+
+K8s 多实例部署时推荐通过 Deployment 注入 `SERVICE_NAME`，避免镜像里写死。
+
+---

llm_toolforge-0.3.0/pyproject.toml

@@ -0,0 +1,51 @@
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "llm-toolforge"
+version = "0.3.0"
+description = "LLM工具调用框架，同时提供 HTTP API 和 MCP Server 两种接入方式"
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.10"
+dependencies = [
+    "fastapi",
+    "uvicorn",
+    "aiofiles",
+    "pydantic",
+    "loguru",
+    "pyyaml",
+    "mcp[cli]",
+    "tzdata",
+]
+
+[project.optional-dependencies]
+# AI 模型渠道（按需安装）
+ai        = ["openai", "volcengine-python-sdk[ark]"]
+# 对象存储（按需安装）
+aliyun    = ["oss2"]
+tencent   = ["cos-python-sdk-v5"]
+# 日志后端（按需安装，与 config.yaml 里的 mysql/sqlite/redis 配置对应）
+mysql     = ["aiomysql"]
+sqlite    = ["aiosqlite"]
+redis     = ["redis>=5.0"]
+# 常用组合
+all-storage   = ["llm-toolforge[aliyun,tencent]"]
+all-infra     = ["llm-toolforge[mysql,sqlite,redis]"]
+all           = ["llm-toolforge[ai,all-storage,all-infra]"]
+
+[project.scripts]
+toolforge = "llm_toolforge.cli:main"
+
+[tool.setuptools.packages.find]
+where   = ["src"]
+include = ["llm_toolforge*"]
+exclude = ["llm_toolforge.templates*"]  # templates 是文本资源，通过 package_data 包含
+
+[tool.setuptools.package-data]
+llm_toolforge = [
+    "static/**/*",
+    "fonts/**/*",
+    "templates/**/*",
+]

llm_toolforge-0.3.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

llm_toolforge-0.3.0/src/llm_toolforge/__init__.py

@@ -0,0 +1,47 @@
+"""
+llm-toolforge
+
+工具开发只需从这里导入：
+
+    from llm_toolforge import (
+        Plugin, InputField, BaseGenerator,
+        GenerateResult, GenerateProgress, ResultStatus,
+        LLMServiceError, UploadError,
+        AIClient, OSSClient,
+        load_tool_config,
+    )
+"""
+
+from .core.base import (
+    BaseGenerator,
+    GenerateProgress,
+    GenerateResult,
+    GeneratorError,
+    InputField,
+    LLMServiceError,
+    Plugin,
+    ResultStatus,
+    UploadError,
+)
+from .core.ai_client import AIClient
+from .core.oss_client import OSSClient
+from .config import load_tool_config, load_config, find_config
+from .discovery import discover_plugins
+
+__all__ = [
+    "Plugin",
+    "BaseGenerator",
+    "InputField",
+    "GenerateResult",
+    "GenerateProgress",
+    "ResultStatus",
+    "GeneratorError",
+    "LLMServiceError",
+    "UploadError",
+    "AIClient",
+    "OSSClient",
+    "load_tool_config",
+    "load_config",
+    "find_config",
+    "discover_plugins",
+]