使用说明

项目简介

MCPS (Model Context Protocol System) 是一个基于 Elixir 开发的系统,旨在为 AI 和机器学习模型提供标准化的上下文管理。它通过 RESTful API 提供上下文的创建、读取、更新、删除、版本控制和转换等核心功能,并具备完善的监控和遥测能力。虽然项目名称包含 "Model Context Protocol",但实际实现采用 RESTful API 而非 JSON-RPC 协议。

主要功能点

  • 上下文管理: 提供完整的 CRUD 操作来管理模型上下文,包括版本控制和历史记录跟踪。
  • 上下文转换管道: 支持配置灵活的转换管道,用于处理和转换上下文数据,内置多种常用转换器,并可扩展自定义转换器。
  • RESTful API 网关: 提供清晰的 RESTful API 接口,方便客户端集成和访问上下文服务。API 使用 JSON 格式进行数据交换,并提供 Swagger 文档。
  • 监控与遥测: 收集系统性能指标和操作数据,集成 Prometheus 用于监控,并提供健康检查接口。
  • 安全机制: 支持基于 Bearer Token 和 API Key 的身份验证,以及速率限制和配额管理。

安装步骤

  1. 克隆仓库:
    git clone https://github.com/sepulvedaavila/model-context-protocol.git
    cd model_context_protocol
  2. 安装依赖:
    mix deps.get
  3. 创建并迁移数据库:
    mix ecto.create
    mix ecto.migrate
  4. 启动服务器:
    mix phx.server
    服务器默认运行在 'http://localhost:4000',API 接口地址为 'http://localhost:4000/api',Swagger 文档地址为 'http://localhost:4000/api/swagger'。

服务器配置

MCP 客户端如果需要配置 MCPS 服务器的启动信息,可以参考以下 JSON 格式:

{
  "server name": "mcps-server",
  "command": "mix",
  "args": ["phx.server"]
  //  server name:  服务器的名称,可以自定义。
  //  command:      启动服务器的命令,这里使用 Elixir 的 'mix' 命令。
  //  args:         启动命令的参数,'phx.server' 表示启动 Phoenix 服务器。
  //                可以根据需要添加其他参数,例如指定端口:["phx.server", "--port", "8080"]
}

注意: MCPS 服务器的详细配置(如数据库连接、端口、认证方式等)需要在服务器端的配置文件 'config/config.exs', 'config/dev.exs' 等文件中进行修改。MCP 客户端通常只需要配置启动服务器的命令,无需关注服务器内部配置。

基本使用方法

MCPS 服务器启动后,客户端可以通过 HTTP 请求访问其 RESTful API。

  • 查看 API 文档: 访问 'http://localhost:4000/api/swagger' 查看详细的 API 接口文档,了解如何使用 Contexts 和 Pipelines 等 API 接口。
  • 使用 API 客户端: 可以使用 Postman, curl 等 HTTP 客户端工具,或者在代码中使用 HTTP 库,根据 API 文档发送请求,进行上下文管理和管道操作。
  • 身份验证: API 请求通常需要身份验证,根据 API 文档,可以使用 Bearer Token 或 API Key 在请求头中进行身份验证。

信息

分类

AI与计算