update project structure

Author: MuggleJinx

README.md

@@ -0,0 +1,88 @@
+#!/usr/bin/env python3
+"""
+MCP Server - dynamically loads tools from config file
+
+This is a standalone executable script for running MCP servers.
+It can be used by MCP clients to start servers with different configurations.
+
+Usage:
+    mcp-serve config.json
+    mcp-serve config.json --mode streamable-http --port 8080
+"""
+
+import argparse
+import sys
+from pathlib import Path
+
+try:
+    from mcpify.wrapper import MCPWrapper
+except ImportError:
+    print("❌ Error: mcpify package not found. Please install it with:")
+    print("   pip install mcpify")
+    sys.exit(1)
+
+
+def main():
+    """Main entry point for the MCP server"""
+    parser = argparse.ArgumentParser(
+        description="MCP Server - loads tools from config file", prog="mcp-serve"
+    )
+    parser.add_argument("config_file", help="Path to the MCP configuration file")
+    parser.add_argument(
+        "--mode",
+        choices=["stdio", "streamable-http"],
+        default="stdio",
+        help="Server mode (default: stdio)",
+    )
+    parser.add_argument(
+        "--host", default="localhost", help="Host for HTTP mode (default: localhost)"
+    )
+    parser.add_argument(
+        "--port", type=int, default=8080, help="Port for HTTP mode (default: 8080)"
+    )
+
+    args = parser.parse_args()
+
+    # Check if config file exists
+    config_file = Path(args.config_file)
+    if not config_file.exists():
+        print(f"❌ Error: Configuration file does not exist: {config_file}")
+        sys.exit(1)
+
+    try:
+        # Create wrapper
+        wrapper = MCPWrapper(str(config_file))
+
+        # Start server based on mode
+        if args.mode == "stdio":
+            print("🚀 Starting MCP server in stdio mode...")
+            wrapper.run()
+        elif args.mode == "streamable-http":
+            print(
+                f"🚀 Starting MCP server in HTTP mode on " f"{args.host}:{args.port}..."
+            )
+            mcp_server = wrapper.server()
+
+            # Start backend if needed
+            if wrapper.adapter:
+                import asyncio
+
+                asyncio.run(wrapper.start_backend())
+
+            try:
+                mcp_server.run(transport="sse", host=args.host, port=args.port)
+            finally:
+                if wrapper.adapter:
+                    import asyncio
+
+                    asyncio.run(wrapper.stop_backend())
+
+    except KeyboardInterrupt:
+        print("\n🛑 Server stopped.")
+    except Exception as e:
+        print(f"❌ Error starting server: {e}")
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

bin/mcp-serve

@@ -0,0 +1,231 @@
+# MCPify Usage Guide
+
+MCPify 提供了简化的命令行界面，将"生成"和"运行"分离开来，让MCP客户端可以更灵活地控制服务器的启动。
+
+## 项目架构
+
+```
+mcpify/
+├── mcpify/                    # 核心包
+│   ├── cli.py                 # CLI入口 (mcpify命令)
+│   ├── server.py              # 服务器入口 (mcp-server命令)
+│   ├── wrapper.py             # MCP包装器
+│   ├── backend.py             # 后端适配器
+│   ├── detect.py              # API检测
+│   └── validate.py            # 配置验证
+├── bin/                       # 独立可执行脚本
+│   └── mcp-serve              # 独立服务器脚本
+├── examples/                  # 示例配置文件
+│   ├── fastapi-example.json
+│   ├── python-module-example.json
+│   └── commandline-example.json
+└── docs/                      # 文档
+    └── usage.md
+```
+
+## 命令概览
+
+### 1. 检测项目API
+```bash
+mcpify detect /path/to/project --output config.json
+```
+
+### 2. 查看配置文件
+```bash
+mcpify view config.json
+```
+
+### 3. 验证配置文件
+```bash
+mcpify validate config.json
+```
+
+### 4. 启动MCP服务器
+```bash
+# 启动stdio模式（默认）
+mcpify serve config.json
+
+# 启动HTTP流式模式
+mcpify serve config.json --mode streamable-http --port 8080
+```
+
+## 独立服务器脚本
+
+项目提供了多种方式来启动MCP服务器：
+
+### 方式1：使用独立脚本（推荐给MCP客户端）
+```bash
+# 使用bin目录下的独立脚本
+./bin/mcp-serve config.json
+./bin/mcp-serve config.json --mode streamable-http --port 8080
+```
+
+### 方式2：通过mcpify CLI
+```bash
+# 使用mcpify命令
+mcpify serve config.json
+mcpify serve config.json --mode streamable-http --port 8080
+```
+
+### 方式3：直接调用模块
+```bash
+# 直接调用Python模块
+python -m mcpify serve config.json
+python -m mcpify serve config.json --mode streamable-http --port 8080
+```
+
+## 使用场景
+
+### 场景1：开发和测试
+```bash
+# 1. 检测项目API
+mcpify detect my-project --output my-project.json
+
+# 2. 查看生成的配置
+mcpify view my-project.json
+
+# 3. 直接启动服务器进行测试
+mcpify serve my-project.json
+```
+
+### 场景2：MCP客户端集成
+MCP客户端可以通过多种方式启动服务器：
+
+```bash
+# 使用独立脚本（推荐）
+./bin/mcp-serve config.json
+
+# 使用mcpify CLI
+mcpify serve config.json
+
+# 使用模块调用
+python -m mcpify serve config.json
+```
+
+### 场景3：生产部署
+```bash
+# 启动HTTP模式的服务器，监听特定端口
+./bin/mcp-serve config.json --mode streamable-http --host 0.0.0.0 --port 8080
+```
+
+## 配置文件示例
+
+查看 `examples/` 目录下的示例配置文件：
+
+### FastAPI 后端示例
+```json
+{
+  "name": "my-fastapi-server",
+  "description": "FastAPI backend server",
+  "backend": {
+    "type": "fastapi",
+    "base_url": "http://localhost:8000"
+  },
+  "tools": [
+    {
+      "name": "get_user",
+      "description": "Get user information",
+      "endpoint": "/users/{user_id}",
+      "method": "GET",
+      "parameters": [
+        {
+          "name": "user_id",
+          "type": "string",
+          "description": "User ID"
+        }
+      ]
+    }
+  ]
+}
+```
+
+### Python 模块后端示例
+```json
+{
+  "name": "my-python-module",
+  "description": "Python module backend",
+  "backend": {
+    "type": "python",
+    "module_path": "./my_module.py"
+  },
+  "tools": [
+    {
+      "name": "calculate",
+      "description": "Perform calculation",
+      "function": "calculate",
+      "parameters": [
+        {
+          "name": "expression",
+          "type": "string",
+          "description": "Mathematical expression"
+        }
+      ]
+    }
+  ]
+}
+```
+
+### 命令行工具后端示例
+```json
+{
+  "name": "my-cli-tool",
+  "description": "Command line tool backend",
+  "backend": {
+    "type": "commandline",
+    "config": {
+      "command": "python3",
+      "args": ["./my_script.py"],
+      "cwd": "."
+    }
+  },
+  "tools": [
+    {
+      "name": "process_data",
+      "description": "Process data with CLI tool",
+      "args": ["process", "{input_file}"],
+      "parameters": [
+        {
+          "name": "input_file",
+          "type": "string",
+          "description": "Input file path"
+        }
+      ]
+    }
+  ]
+}
+```
+
+## 支持的后端类型
+
+- `fastapi`: FastAPI应用
+- `python`: Python模块
+- `external`: 外部命令行工具
+- `commandline`: 简单命令行工具（向后兼容）
+
+## 服务器模式
+
+- `stdio`: 标准输入输出模式（MCP默认）
+- `streamable-http`: HTTP服务器端事件流模式
+
+## 安装和部署
+
+### 开发安装
+```bash
+pip install -e .
+```
+
+### 生产安装
+```bash
+pip install mcpify
+```
+
+### 使用独立脚本（无需安装）
+```bash
+# 复制bin/mcp-serve到目标位置
+cp bin/mcp-serve /usr/local/bin/
+chmod +x /usr/local/bin/mcp-serve
+# 然后可以直接使用
+mcp-serve config.json
+```
+
+这种设计让MCP客户端可以完全控制服务器的启动时机和方式，同时提供了多种部署选项以适应不同的使用场景。

docs/usage.md

@@ -0,0 +1,58 @@
+# MCPify Configuration Examples
+
+This directory contains example configuration files for different types of backends and use cases.
+
+## Available Examples
+
+### 1. FastAPI Backend (`fastapi-example.json`)
+Example configuration for a FastAPI web application backend.
+- **Backend Type**: `fastapi`
+- **Use Case**: REST API servers, web applications
+- **Features**: HTTP endpoints, automatic parameter validation
+
+### 2. Python Module Backend (`python-module-example.json`)
+Example configuration for a Python module/script backend.
+- **Backend Type**: `python`
+- **Use Case**: Python functions, data processing scripts
+- **Features**: Direct function calls, Python-native integration
+
+### 3. Command Line Tool Backend (`commandline-example.json`)
+Example configuration for command-line tools and external programs.
+- **Backend Type**: `commandline`
+- **Use Case**: CLI tools, shell scripts, external executables
+- **Features**: Process execution, argument templating
+
+## Usage
+
+To test any of these examples:
+
+```bash
+# View the configuration
+mcpify view examples/fastapi-example.json
+
+# Validate the configuration
+mcpify validate examples/fastapi-example.json
+
+# Start the server (make sure the backend is running first)
+mcpify serve examples/fastapi-example.json
+
+# Or use the standalone server
+mcp-serve examples/fastapi-example.json
+```
+
+## Customization
+
+These examples serve as templates. You can:
+
+1. Copy an example that matches your backend type
+2. Modify the backend configuration (URLs, paths, commands)
+3. Update the tools section to match your API
+4. Add or remove parameters as needed
+
+## Backend Requirements
+
+- **FastAPI**: Requires a running FastAPI server
+- **Python**: Requires the Python module to be available
+- **Command Line**: Requires the command/executable to be installed
+
+For more detailed usage instructions, see `docs/usage.md`.

example-projects/.DS_Store

@@ -75,4 +75,4 @@ Result: 10 + 20 = 30
 ```
 
 ## License
-This project is licensed under the MIT License.
+This project is licensed under the MIT License.