io 模型 SDK 文档

简介

这个文档是关于 io.model SDK 的详细介绍，它为构建支持模型的应用程序提供了工具、资源和提示的接口。

主要特点

• 统一协议：通过 JSON-RPC 2.0 协议实现标准化交互。
• 多语言支持：虽然当前是用 Clojure 实现的，但未来计划支持其他语言。
• 可扩展性：便于添加新的工具、资源和提示。

快速开始

安装

要在项目中使用该 SDK，请将以下依赖加入到 deps.edn：

io.model.context {:mvn/version "0.1.0"}

创建上下文

创建一个基本的上下文实例，如下所示：

(require [io.model.context :as ctx])

(let [context (ctx/create-context)]
  (with-retry context))

核心概念

上下文

上下文是工具、资源和提示的容器。你可以通过以下方式创建一个空上下文：

(empty-context)

然后添加工具、资源或提示。

工具

工具是可以执行命令的函数，如计算器。 注册工具的方法如下：

(add-tool context :name tool-fn & args)

资源

资源是提供内容的函数，例如从文件读取内容。 注册资源的方式为：

(add-resource context :uri resource-fn)

提示

提示是生成回复消息的函数，常用于对话系统。 注册提示的方法是：

(add-prompt context :name prompt-fn & args)

传输层

实现自定义传输协议只需继承 Transport 接口并实现以下方法：

• initialize
• read-message
• write-message

客户端 API

通过客户端 API 可以与服务器进行交互，主要包含以下方法：

初始化

(init context)

工具交互

(call-tool context tool-name args)
(list-tools context)

资源管理

(read-resource context uri)
(subscribe-resource context uri callback)
(unsubscribe-resource context subscription-id)
(list-resources context)

提示系统

(get-prompt context prompt-name args)
(list-prompts context)

健康检查

(ping context)

示例代码

创建上下文

(let [context (empty-context)]
  (add-tool context :calculate #(apply + %&))
  (add-resource context "file.txt" #(slurp %))
  (add-prompt context :greeting #(str "Hello, " %))
)

使用客户端

(let [client (create-client transport)]
  (init client)
  (ping client)
  (call-tool client :calculate [1 2 3])
  (read-resource client "file.txt")
  (subscribe-resource client "file.txt" #(println %))
)

更多信息

如需深入了解如何在项目中使用该 SDK，请参考以下链接：

• 官方文档：https://example.com/docs

待办事项

查看 todo.org 文件 了解待完成的工作，按计划顺序处理。

开发指南

这是一个标准的 deps-new 项目，所有 deps-new 命令均可正常运行。要运行项目测试：

$ make test ## 或 clojure -T:build test

构建 JAR 包并运行 CI 管道：

$ make build ## 或 clojure -T:build ci

本地安装：

$ make install ## 或 clojure -T:build install

部署到 Clojars 需要设置 CLOJARS_USERNAME 和 CLOJARS_PASSWORD 环境变量（需先运行 ci 任务）：

$ make deploy ## 或 clojure -T:build deploy

致谢

此 SDK 基于 lsp4clj 构建，它解决了处理所有 JSON-RPC 边缘情况的难题。在意识到 lsp4clj 的智能方法之前，我是手动构建了这一层，并发现了所有的边缘情况。

许可证

版权 © 2025 Unravel.tech

根据 MIT 许可证分发