chore(general): 更新项目配置文件
- 添加必要的配置项 - 优化现有设置 - 确保环境兼容性
This commit is contained in:
65
lzwcai_mcpskills_template/README.md
Normal file
65
lzwcai_mcpskills_template/README.md
Normal file
@@ -0,0 +1,65 @@
|
||||
# lzwcai-mcpskills-template
|
||||
|
||||
MCP Server 模板项目,用于快速创建新的 MCP 服务。
|
||||
|
||||
## 功能
|
||||
|
||||
- 提供 MCP Server 基础框架
|
||||
- 支持动态工具注册
|
||||
- 内置日志系统
|
||||
- 支持环境变量配置
|
||||
|
||||
## 安装
|
||||
|
||||
```bash
|
||||
pip install lzwcai-mcpskills-template
|
||||
```
|
||||
|
||||
## 使用
|
||||
|
||||
```bash
|
||||
# 设置环境变量
|
||||
export API_KEY="your-api-key"
|
||||
export BASE_URL="http://your-api-server"
|
||||
|
||||
# 运行
|
||||
lzwcai-mcpskills-template
|
||||
```
|
||||
|
||||
## 环境变量
|
||||
|
||||
| 变量名 | 说明 | 默认值 |
|
||||
|--------|------|--------|
|
||||
| API_KEY | API密钥 | - |
|
||||
| BASE_URL | 后端API地址 | http://localhost:8080 |
|
||||
|
||||
## 项目结构
|
||||
|
||||
```
|
||||
lzwcai_mcpskills_template/
|
||||
├── main.py # 入口文件
|
||||
├── pyproject.toml # 项目配置
|
||||
├── README.md # 说明文档
|
||||
└── lzwcai_mcpskills_template/ # 核心代码
|
||||
├── main.py # MCP Server 主逻辑
|
||||
├── schema_converter.py # Schema 转换器
|
||||
└── utils/ # 工具模块
|
||||
├── __init__.py
|
||||
├── api_client.py # API 客户端
|
||||
├── env_config.py # 环境变量配置
|
||||
├── json_helper.py # JSON 工具
|
||||
└── logger_config.py # 日志配置
|
||||
```
|
||||
|
||||
## 开发
|
||||
|
||||
基于此模板创建新项目:
|
||||
|
||||
1. 复制整个目录
|
||||
2. 修改 `pyproject.toml` 中的项目名称
|
||||
3. 修改 `lzwcai_mcpskills_template` 目录名
|
||||
4. 在 `main.py` 中实现你的工具逻辑
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
Reference in New Issue
Block a user