89 lines
3.2 KiB
Markdown
89 lines
3.2 KiB
Markdown
# OpenMCP Document
|
||
|
||
## 📚 项目简介
|
||
OpenMCP 是基于 MCP 协议（Multi-Model Communication Protocol）开发的开源框架，由开发者 **LSTM-Kirigaya** 创建。该项目通过深度整合 DeepSeek 等大模型 API，提供了一套完整的工具链，支持开发者通过自然语言与数据库（如 Neo4j）、本地资源及外部工具交互，实现自动化开发、资讯聚合等场景。项目文档仓库包含技术原理、开发指南及示例代码。
|
||
|
||
## 🌟 核心特性
|
||
|
||
### 1. **MCP 协议支持**
|
||
- **Resources**：支持访问本地文件系统、数据库等静态资源，扩展大模型上下文。
|
||
- **Prompts**：提供场景化 Prompt 模板，引导大模型生成结构化输出。
|
||
- **Tools**：封装函数工具（如酒店预订、网页操作），通过 Function Calling 实现 AI 与现实世界的交互。
|
||
|
||
### 2. **低成本高效开发**
|
||
- 深度集成 **DeepSeek API**，Token 消耗极低（开发者实例：月均费用 19 元，对比 OpenAI API 成本降低 70%+）。
|
||
- 支持凌晨调用 API 享受更低价格，降低个人开发者门槛。
|
||
|
||
### 3. **典型应用场景**
|
||
- **自动化开发**：通过自然语言生成代码（如后端服务、Neo4j 交互）。
|
||
- **资讯机器人**：定时推送最新资讯（示例：每日 10 点群发技术动态）。
|
||
- **AI 工具链**：快速构建 AI 驱动的工具（如数据分析、智能客服）。
|
||
|
||
## 🚀 快速开始
|
||
|
||
### 1. 环境准备
|
||
```bash
|
||
# 安装依赖
|
||
pip install numpy opencv-python tqdm # 示例依赖，具体见项目文档
|
||
```
|
||
|
||
### 2. 核心功能示例
|
||
```python
|
||
from openai import OpenAI
|
||
|
||
# 初始化 DeepSeek 客户端
|
||
client = OpenAI(
|
||
api_key="YOUR_DEEPSEEK_KEY",
|
||
base_url="https://api.deepseek.com"
|
||
)
|
||
|
||
# 调用大模型处理任务
|
||
response = client.chat.completions.create(
|
||
model="deepseek-chat",
|
||
messages=[
|
||
{"role": "system", "content": "你是一个自动化开发助手"},
|
||
{"role": "user", "content": "用 Python 写一个连接 Neo4j 的 CRUD 接口"}
|
||
]
|
||
)
|
||
|
||
print(response.choices[0].message.content)
|
||
```
|
||
|
||
## 🛠️ 开发贡献
|
||
|
||
### 1. 本地开发流程
|
||
1. Fork 仓库并克隆：
|
||
```bash
|
||
git clone https://github.com/YOUR_USERNAME/openmcp-document.git
|
||
```
|
||
2. 安装开发依赖：
|
||
```bash
|
||
pip install -r requirements.txt
|
||
```
|
||
3. 提交代码并推送 PR。
|
||
|
||
### 2. 打包发布（针对核心库）
|
||
```bash
|
||
# 生成发布包
|
||
python -m build
|
||
# 上传至 PyPI
|
||
twine upload dist/*
|
||
```
|
||
|
||
## 📞 交流社区
|
||
- **QQ 群**：782833642（OpenMCP 技术交流）
|
||
- **开发者博客**：[Kirigaya 技术专栏](https://zhuanlan.zhihu.com/kirigaya)
|
||
|
||
## 📄 许可证
|
||
本项目采用 **Apache 2.0** 许可证，允许自由使用、修改及商业发布（需保留版权声明）。
|
||
|
||
## 🙏 致谢
|
||
- 感谢 **DeepSeek** 提供低成本、高性能的大模型 API。
|
||
- 感谢所有贡献者及社区用户的反馈与支持！
|
||
|
||
---
|
||
|
||
**Star 历史**
|
||
|
||
👉 [立即体验 OpenMCP](https://github.com/LSTM-Kirigaya/openmcp-document) | [文档地址](https://github.com/LSTM-Kirigaya/openmcp-document/wiki)
|