使用说明

项目简介

Croft MCP Server 是一个使用 PHP Laravel 框架开发的后端应用,它实现了 Model Context Protocol (MCP) 服务器,用于增强 AI 代码助手的功能。该项目旨在作为 AI 编程工具(如 Cursor)的上下文服务器,提供资源管理、工具注册和 Prompt 模板等核心 MCP 功能。

主要功能点

  • MCP 服务器实现: 基于 Laravel 框架,提供 MCP 协议的服务端实现,支持 JSON-RPC 通信。
  • 资源管理 (Resources): 可能支持托管和管理代码片段、项目文档等资源,供 AI 模型访问和利用(具体功能需查看代码实现)。
  • 工具注册与执行 (Tools): 可能允许注册和执行外部工具,扩展 AI 编程助手的功能,例如代码生成、测试运行等(具体功能需查看代码实现)。
  • Prompt 模板 (Prompts): 可能支持定义和渲染 Prompt 模板,定制与 AI 模型的交互方式(具体功能需查看代码实现)。
  • Laravel 框架: 利用 Laravel 框架的优势,提供稳定、可扩展的服务器端基础。

安装步骤

  1. 环境准备: 确保已安装 PHP 和 Composer。
  2. 安装 Croft MCP Server: 使用 Composer 安装 Croft 包:
    composer require ashleyhindle/croft
  3. 发布迁移文件: 发布数据库迁移文件:
    php artisan vendor:publish --tag="croft-migrations"
  4. 执行数据库迁移: 运行数据库迁移命令,创建所需数据表:
    php artisan migrate
  5. 发布配置文件 (可选): 如果需要自定义配置,可以发布配置文件:
    php artisan vendor:publish --tag="croft-config"

服务器配置

要使 MCP 客户端(例如 Cursor)连接到 Croft MCP Server,您需要在 MCP 客户端中配置服务器的启动命令和参数。 假设您使用 Laravel 的 'artisan serve' 命令启动 Croft 服务器,则客户端配置可能如下所示:

{
  "serverName": "Croft MCP Server",
  "command": "php",
  "args": ["artisan", "serve"]
}

注意: 上述配置假设您在 Croft 项目的根目录下运行服务器。 实际部署时,您可能需要根据服务器环境(例如使用 Nginx 或 Apache)调整 'command' 和 'args'。 具体的 MCP 服务器地址和端口取决于 'artisan serve' 的默认设置或您的自定义配置。 更详细的服务器端点和功能需要参考 Croft MCP Server 的代码实现和更全面的文档(如果存在)。

基本使用方法

安装并启动 Croft MCP Server 后,配置支持 MCP 协议的客户端(如 Cursor),使其连接到 Croft 服务器。 客户端将能够利用 Croft 服务器提供的资源、工具和 Prompt 模板来增强 AI 编程体验。 具体的使用方式和功能取决于 Croft MCP Server 实现的具体 MCP 功能,请参考客户端和服务器的详细文档。

信息

分类

开发者工具