OCaml MCP - Model Context Protocol Server for OCaml Documentation

OCaml MCP - Model Context Protocol Server for OCaml Documentation

site icon
2025.03.21 0
OCaml文档服务API 服务开发效率
OCaml MCP 是一个为 OCaml 文档系统设计的服务器实现,通过 Model Context Protocol (MCP) 向 AI 助手提供文档数据。它作为 OCaml.org 文档库的智能代理,提供 RESTful 和 JSON-RPC 接口,帮助 LLMs 提供更准确的 OCaml 编码辅助。
View on GitHub

Overview

基本能力

产品定位

OCaml MCP 是一个桥接 OCaml 文档系统和 AI 助手的服务器,旨在通过 MCP 协议提供 OCaml 包的文档数据。

核心功能

  • 包信息检索:访问 OCaml 文档系统中任何包的完整文档。
  • 包状态信息:检查 OCaml 包的状态。
  • 原始 JavaScript 内容:返回文档 JS 文件的完整内容,供 LLMs 解析。
  • 双 API:提供 RESTful 和 JSON-RPC 接口。
  • 基于 OCaml 5:利用 Eio 进行并发 I/O。

适用场景

  • AI 助手需要访问 OCaml 文档以提供编码辅助。
  • 开发者需要快速获取 OCaml 包的文档和状态信息。

工具列表

  • RESTful API:通过 HTTP GET 请求获取包信息和状态。
  • JSON-RPC API:通过 HTTP POST 请求执行 MCP 方法。

常见问题解答

  • 如何获取最新版本的包信息?:目前需要明确指定版本号,未来计划支持自动获取最新版本。

使用教程

使用依赖

  • OCaml 5.x 或更高版本
  • Opam (OCaml 包管理器)
  • Dune 构建系统

安装教程

  1. 克隆仓库: git clone https://github.com/yourusername/ocaml_mcp.git cd ocaml_mcp
  2. 安装依赖: opam install . --deps-only
  3. 构建项目: dune build

调试方式

启动服务器(默认端口 8080):

dune exec ocaml_mcp

测试 API:

curl -X GET "http://localhost:8080/packages/fmt/0.10.0/info"
curl -X POST "http://localhost:8080/mcp" \
  -H "Content-Type: application/json" \
  -d '{"id": "1", "method": "getPackageInfo", "params": {"packageName": "fmt", "version": "0.10.0"}}'

许可证

该项目遵循 Not specified in README, but refers to a LICENSE file 开源许可条款。