Contextbase

笔记官方认证 TypeScript

🚀 上下文基础 (MCP 服务器)

上下文基础是一个专为 AI 代理、助手和应用程序打造的模型上下文协议 (MCP) 服务器。它能够高效地存储、检索和管理用户的上下文信息，并且通过简单的 API 来实现这些功能。

🚀 快速开始

上下文基础服务器为 AI 相关应用提供了便捷的上下文信息管理方案。通过简单的 API，你可以轻松地存储、检索和管理用户的上下文信息。

✨ 主要特性

身份验证系统：运用 JWT 和 bcrypt 技术，实现安全可靠的用户认证。
记忆管理：提供专门的 API 端点，用于存储和检索记忆数据。
日志系统：全面且细致地记录用户的操作日志。
现代技术栈：基于 TypeScript、Fastify、Prisma ORM 进行开发，保证系统的先进性和高效性。
数据库集成：采用 PostgreSQL 数据库，实现数据的持久化存储。
缓存：借助 Redis 实现高性能缓存，提升系统响应速度。

📦 安装指南

先决条件

Node.js (v14 或更高版本)
PostgreSQL 数据库
Redis 服务器
Docker 及 Docker Compose (可选，用于容器化部署)

安装步骤

克隆仓库

git clone https://github.com/imfeniljikadara/contextbase.git
cd mcp

安装依赖项
```
cd mcp-server
npm install
```

配置环境变量 在 mcp-server 目录下创建一个 .env 文件，并添加以下变量：

DATABASE_URL=postgresql://username:password@localhost:5432/mcp
REDIS_HOST=localhost
REDIS_PORT=6379
JWT_SECRET=your_jwt_secret
PORT=3000

运行数据库迁移
```
npx prisma migrate dev
```
启动服务器
```
npm start
```
或者使用 Docker 启动：
```
docker-compose up
```

📚 详细文档

API 端点

身份验证

POST /api/auth/register - 注册新用户
POST /api/auth/login - 登录并获取 JWT 访问令牌

记忆

GET /api/memory - 获取所有记忆
POST /api/memory - 创建新的记忆
GET /api/memory/:id - 获取特定记忆
PUT /api/memory/:id - 更新记忆
DELETE /api/memory/:id - 删除记忆

日志

GET /api/logs - 获取用户操作日志

开发信息

使用开发模式运行：
```
npm run dev
```
执行测试：
```
npm test
```

项目结构

mcp-server/
├── prisma/              # 数据库架构和迁移文件
├── src/
│   ├── api/             # API 路由和控制器
│   ├── config/          # 配置文件
│   ├── db/              # 数据库连接 (PostgreSQL, Redis)
│   ├── middleware/      # 自定义中间件
│   ├── models/          # 数据模型
│   ├── services/        # 业务逻辑
│   ├── utils/           # 工具函数
│   └── index.ts         # 应用程序入口点
├── scripts/             # 辅助脚本
├── .env                 # 环境变量文件
└── package.json         # 依赖项和脚本

📄 许可证

本项目采用 MIT 许可证。

0 条评论
分类：笔记