MCP Clojure Sdk

🚀 io 模型 SDK 文檔

本 SDK 為構建支持模型的應用程序提供了工具、資源和提示的接口，藉助它可以更高效地開發相關應用，解決開發過程中與模型交互的難題。

🚀 快速開始

📦 安裝指南

要在項目中使用該 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))

✨ 主要特性

• 統一協議：通過 JSON - RPC 2.0 協議實現標準化交互。
• 多語言支持：雖然當前是用 Clojure 實現的，但未來計劃支持其他語言。
• 可擴展性：便於添加新的工具、資源和提示。

📚 詳細文檔

核心概念

上下文

上下文是工具、資源和提示的容器。你可以通過以下方式創建一個空上下文：

(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 %))
)

🔧 技術細節

這是一個標準的 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

📄 許可證

版權 © 2025 Unravel.tech

根據 MIT 許可證分發。

更多信息

如需深入瞭解如何在項目中使用該 SDK，請參考以下鏈接：

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

待辦事項

查看 todo.org 文件 瞭解待完成的工作，按計劃順序處理。

致謝

此 SDK 基於 lsp4clj 構建，它解決了處理所有 JSON - RPC 邊緣情況的難題。在意識到 lsp4clj 的智能方法之前，作者是手動構建了這一層，並發現了所有的邊緣情況。