FastMCP-Scala

A high‑level, developer‑friendly Scala 3 library for building Model Context Protocol (MCP) servers.

Features

• ZIO‑based effect handling and async support
• Annotation‑driven API (@Tool, @Resource, @Prompt)
• Automatic JSON Schema & handler generation via Scala 3 macros
• Seamless integration with the Java MCP SDK

Installation

Add to your build.sbt (defaulting to Scala 3.7.2):

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

Quickstart

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

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

// Define annotated tools, prompts, and resources
object Example:
    @Tool(name = Some("add"), description = Some("Add two numbers"))
    def add(
             @Param("First operand") a: Double,
             @Param("Second operand") b: Double
           ): Double = a + b
    
    @Prompt(name = Some("greet"), description = Some("Generate a greeting message"))
    def greet(@Param("Name to greet") name: String): String =
      s"Hello, $name!"
    
    @Resource(uri = "file://test", description = Some("Test resource"))
    def test(): String = "This is a test"
    
    @Resource(uri = "user://{userId}", description = Some("Test resource"))
    def getUser(@Param("The user id") userId: String): String = s"User ID: $userId"

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

Running Examples

The above example can be run using scala-cli README.md or scala-cli scripts/quickstart.sc from the repo root. You can run the server via the MCP inspector by running:

npx @modelcontextprotocol/inspector scala-cli README.md

or

npx @modelcontextprotocol/inspector scala-cli scripts/quickstart.sc

You can also run examples directly from the command line:

scala-cli \
    -e '//> using dep com.tjclp::fast-mcp-scala:0.2.2' \
    --main-class com.tjclp.fastmcp.examples.AnnotatedServer

[!WARNING] As of now, only STDIO is supported. We plan to support streamable http in the future.

Integration with Claude Desktop

In Claude desktop, you can add the following to your claude_desktop_config.json:

{
  "mcpServers": {
    "example-fast-mcp-server": {
      "command": "scala-cli",
      "args": [
        "-e",
        "//> using dep com.tjclp::fast-mcp-scala:0.2.2",
        "--main-class",
        "com.tjclp.fastmcp.examples.AnnotatedServer"
      ]
    }
  }
}

Note: FastMCP-Scala example servers are for demo purposes only and don't do anything useful

For additional examples and in‑depth docs, see docs/guide.md.

License

MIT

---

Development Documentation

Developing Locally

When hacking on FastMCP‑Scala itself, you can consume a local build in any project.

🔨 Build Commands (Mill)

FastMCP-Scala uses Mill as its build tool.

# Compile the library
./mill fast-mcp-scala.compile

# Run tests
./mill fast-mcp-scala.test

# Check code formatting
./mill fast-mcp-scala.checkFormat

# Auto-format code
./mill fast-mcp-scala.reformat

# Generate test coverage report
./mill fast-mcp-scala.scoverage.htmlReport

🔨 Publish to the Local Ivy Repository

# From the fast-mcp-scala root
./mill fast-mcp-scala.publishLocal

Then, in your consuming sbt project:

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

Or in Mill:

def ivyDeps = Agg(
  ivy"com.tjclp::fast-mcp-scala:0.2.3-SNAPSHOT"
)

publishLocal installs the artifact under ~/.ivy2/local.

📦 Use the JAR Directly (Unmanaged Dependencies)

# Build the JAR
./mill fast-mcp-scala.jar

# The JAR is located at:
# out/fast-mcp-scala/jar.dest/out.jar

🚀 Using with scala‑cli

You can use fast-mcp-scala in another scala‑cli project:

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

You can also point directly at the local JAR:

//> using scala 3.7.2
//> using jar "/absolute/path/to/out/fast-mcp-scala/jar.dest/out.jar"
//> using options "-Xcheck-macros" "-experimental"