Fast MCP Scala

🚀 快速MCP-Scala

快速MCP-Scala是一個高級且對開發者友好的Scala 3庫，專門用於構建模型上下文協議（MCP）服務器。它能有效簡化MCP服務器的開發流程，為開發者提供便捷的開發體驗。

🚀 快速開始

快速MCP-Scala能幫助你快速搭建MCP服務器。以下是一個簡單的示例，展示瞭如何使用該庫定義工具、提示和資源，並啟動服務器：

//> using scala 3.6.4
//> using dep com.tjclp::fast-mcp-scala:0.1.0
//> using options "-Xcheck-macros" "-experimental"

import com.tjclp.fastmcp.core.{Tool, ToolParam, Prompt, PromptParam, Resource}
import com.tjclp.fastmcp.server.FastMcpServer
import com.tjclp.fastmcp.macros.RegistrationMacro.*
import zio.*

// 定義帶有註解的工具、提示和資源
object Example:
  @Tool(name = Some("add"), description = Some("Add two numbers"))
  def add(
      @ToolParam("First operand") a: Double,
      @ToolParam("Second operand") b: Double
    ): Double = a + b

  @Prompt(name = Some("greet"), description = Some("Generate a greeting message"))
  def greet(@PromptParam("Name to greet") name: String): String =
    s"Hello, $name!"

  // 注意：資源模板（templated URIs）尚未支持；
  // 當 MCP Java SDK 添加了模板支持後即將實現。
  @Resource(uri = "file://test", description = Some("Test resource"))
  def test(): String = "This is a test"

object ExampleServer extends ZIOAppDefault:
  override def run =
    for
      server <- ZIO.succeed(FastMcpServer("ExampleServer"))
      _      <- ZIO.attempt(server.scanAnnotations[Example.type])
      _      <- server.runStdio()
    yield ()

✨ 主要特性

• 基於ZIO的效果處理和異步支持：藉助ZIO庫，實現高效的效果處理和異步操作，提升服務器性能。
• 註解驅動的API：通過 @Tool, @Resource, @Prompt 等註解，簡化API的定義和使用。
• 自動生成JSON Schema和處理程序：利用 Scala 3 宏，自動生成JSON Schema和處理程序，減少開發工作量。
• 與 Java MCP SDK 的無縫集成：可與 Java MCP SDK 完美配合，實現跨語言開發。

📦 安裝指南

使用sbt

將以下內容添加到您的 build.sbt（默認為 Scala 3.6.4）：

libraryDependencies += "com.tjclp" %% "fast-mcp-scala" % "0.1.0"

使用 Scala CLI

您可以使用以下命令：

//> using scala 3.6.4
//> using dep com.tjclp::fast-mcp-scala:0.1.0
//> using options "-Xcheck-macros" "-experimental"

💻 使用示例

基礎用法

上述的快速開始示例展示瞭如何定義工具、提示和資源，並啟動服務器。以下是示例代碼的再次展示：

//> using scala 3.6.4
//> using dep com.tjclp::fast-mcp-scala:0.1.0
//> using options "-Xcheck-macros" "-experimental"

import com.tjclp.fastmcp.core.{Tool, ToolParam, Prompt, PromptParam, Resource}
import com.tjclp.fastmcp.server.FastMcpServer
import com.tjclp.fastmcp.macros.RegistrationMacro.*
import zio.*

// 定義帶有註解的工具、提示和資源
object Example:
  @Tool(name = Some("add"), description = Some("Add two numbers"))
  def add(
      @ToolParam("First operand") a: Double,
      @ToolParam("Second operand") b: Double
    ): Double = a + b

  @Prompt(name = Some("greet"), description = Some("Generate a greeting message"))
  def greet(@PromptParam("Name to greet") name: String): String =
    s"Hello, $name!"

  // 注意：資源模板（templated URIs）尚未支持；
  // 當 MCP Java SDK 添加了模板支持後即將實現。
  @Resource(uri = "file://test", description = Some("Test resource"))
  def test(): String = "This is a test"

object ExampleServer extends ZIOAppDefault:
  override def run =
    for
      server <- ZIO.succeed(FastMcpServer("ExampleServer"))
      _      <- ZIO.attempt(server.scanAnnotations[Example.type])
      _      <- server.runStdio()
    yield ()

運行示例

上述示例可以通過 scala-cli scripts/quickstart.scala 從倉庫根目錄運行。您可以通過以下命令使用 MCP 檢查器運行服務器：

npx @modelcontextprotocol/inspector scala-cli <path_to_repo>/scripts/quickstart scala

您還可以直接從命令行運行示例：

scala-cli \
    -e '//> using dep com.tjclp::fast-mcp-scala:0.1.0'
    //> using options "-Xcheck-macros" "-experimental"

📚 詳細文檔

與Claude Desktop集成

您可以在 ~/.config/claude 中創建一個文件，內容如下：

export Claude=$((待實現))

📄 許可證

項目在 MIT 許可證下發布。