get basic docc stuff going

Author: odrobnik

Sources/SwiftMCP/Models/Tools/ToolCallResponse.swift

@@ -1,7 +1,7 @@
 import Foundation
 
 /// Response structure for tool calls
-struct ToolCallResponse: Codable {
+public struct ToolCallResponse: Codable {
 	var jsonrpc: String = "2.0"
 	let id: Int
 	let result: Result
@@ -28,7 +28,7 @@ struct ToolCallResponse: Codable {
 }
 
 extension ToolCallResponse {
-	init(id: Int, error: Error)
+	public init(id: Int, error: Error)
 	{
 		self.id = id
 		self.result = Result(
@@ -37,7 +37,7 @@ extension ToolCallResponse {
 		)
 	}
 
-	init(id: Int, result: String)
+	public init(id: Int, result: String)
 	{
 		self.id = id
 		self.result = Result(

Sources/SwiftMCP/SwiftMCP.docc/Articles/GettingStarted.md

@@ -0,0 +1,50 @@
+# Getting Started with SwiftMCP
+
+Create your first MCP server in minutes.
+
+## Overview
+
+SwiftMCP makes it easy to build Model Control Protocol (MCP) servers that can interact with AI models. This guide will help you get started with the basics.
+
+## Installation
+
+Add SwiftMCP to your project using Swift Package Manager:
+
+```swift
+dependencies: [
+    .package(url: "https://github.com/yourusername/SwiftMCP.git", from: "1.0.0")
+]
+```
+
+## Basic Usage
+
+1. Create a new Swift file for your server:
+
+```swift
+import SwiftMCP
+
+@MCPServer(version: "1.0.0")
+struct Calculator {
+    @MCPTool(description: "Adds two numbers together")
+    func add(a: Double, b: Double) -> Double {
+        return a + b
+    }
+}
+```
+
+2. Run your server:
+
+```swift
+import SwiftMCP
+
+let calculator = Calculator()
+let transport = StdioTransport()
+
+try await transport.start(server: calculator)
+```
+
+## Next Steps
+
+- Follow the <doc:BuildingAnMCPServer> tutorial to learn more advanced features
+- Explore the API documentation for detailed information about available options
+- Check out the example projects in the repository 

Sources/SwiftMCP/SwiftMCP.docc/Resources/01-calculator-base.swift

@@ -0,0 +1,15 @@
+/**
+ A Calculator for simple math operations like addition, subtraction, and more.
+ */
+class Calculator {
+    /**
+     Adds two numbers together and returns their sum.
+     
+     - Parameter a: First number to add
+     - Parameter b: Second number to add
+     - Returns: The sum of a and b
+     */
+    func add(a: Double, b: Double) -> Double {
+        return a + b
+    }
+} 

Sources/SwiftMCP/SwiftMCP.docc/Resources/02-calculator-server.swift

@@ -0,0 +1,18 @@
+import SwiftMCP
+
+/**
+ A Calculator for simple math operations like addition, subtraction, and more.
+ */
+@MCPServer(version: "1.0.0")
+class Calculator {
+    /**
+     Adds two numbers together and returns their sum.
+     
+     - Parameter a: First number to add
+     - Parameter b: Second number to add
+     - Returns: The sum of a and b
+     */
+    func add(a: Double, b: Double) -> Double {
+        return a + b
+    }
+} 

Sources/SwiftMCP/SwiftMCP.docc/Resources/03-calculator-tool.swift

@@ -0,0 +1,19 @@
+import SwiftMCP
+
+/**
+ A Calculator for simple math operations like addition, subtraction, and more.
+ */
+@MCPServer(version: "1.0.0")
+class Calculator {
+    /**
+     Adds two numbers together and returns their sum.
+     
+     - Parameter a: First number to add
+     - Parameter b: Second number to add
+     - Returns: The sum of a and b
+     */
+    @MCPTool
+    func add(a: Double, b: Double) -> Double {
+        return a + b
+    }
+} 

Sources/SwiftMCP/SwiftMCP.docc/Resources/04-calculator-named.swift

@@ -0,0 +1,19 @@
+import SwiftMCP
+
+/**
+ A Calculator for simple math operations like addition, subtraction, and more.
+ */
+@MCPServer(version: "1.0.0", name: "SwiftMCP Demo")
+class Calculator {
+    /**
+     Adds two numbers together and returns their sum.
+     
+     - Parameter a: First number to add
+     - Parameter b: Second number to add
+     - Returns: The sum of a and b
+     */
+    @MCPTool
+    func add(a: Double, b: Double) -> Double {
+        return a + b
+    }
+} 

Sources/SwiftMCP/SwiftMCP.docc/Resources/04-greeting-error.swift

@@ -0,0 +1,15 @@
+/*
+A custom error type for handling validation errors in the MCP server.
+*/
+import Foundation
+
+enum GreetingError: LocalizedError {
+    case nameTooShort
+    
+    var errorDescription: String? {
+        switch self {
+        case .nameTooShort:
+            return "Name must be at least 2 characters long"
+        }
+    }
+} 

Sources/SwiftMCP/SwiftMCP.docc/Resources/05-calculator-description.swift

@@ -0,0 +1,19 @@
+import SwiftMCP
+
+/**
+ A Calculator for simple math operations like addition, subtraction, and more.
+ */
+@MCPServer(version: "1.0.0", name: "SwiftMCP Demo")
+class Calculator {
+    /**
+     Adds two numbers together and returns their sum.
+     
+     - Parameter a: First number to add
+     - Parameter b: Second number to add
+     - Returns: The sum of a and b
+     */
+    @MCPTool(description: "Performs addition of two numbers")
+    func add(a: Double, b: Double) -> Double {
+        return a + b
+    }
+} 

Sources/SwiftMCP/SwiftMCP.docc/Resources/05-calculator-throwing.swift

@@ -0,0 +1,17 @@
+import SwiftMCP
+
+@MCPServer(version: "1.0.0")
+struct Calculator {
+    @MCPTool(description: "Adds two numbers together")
+    func add(a: Double, b: Double) -> Double {
+        return a + b
+    }
+    
+    @MCPTool(description: "Greets a person by name")
+    func greet(name: String) throws -> String {
+        guard name.count >= 2 else {
+            throw GreetingError.nameTooShort
+        }
+        return "Hello, \(name)!"
+    }
+} 

Sources/SwiftMCP/SwiftMCP.docc/Resources/06-calculator-async.swift

@@ -0,0 +1,23 @@
+import SwiftMCP
+
+@MCPServer(version: "1.0.0")
+struct Calculator {
+    @MCPTool(description: "Adds two numbers together")
+    func add(a: Double, b: Double) -> Double {
+        return a + b
+    }
+    
+    @MCPTool(description: "Greets a person by name")
+    func greet(name: String) throws -> String {
+        guard name.count >= 2 else {
+            throw GreetingError.nameTooShort
+        }
+        return "Hello, \(name)!"
+    }
+    
+    @MCPTool(description: "Sends a delayed greeting")
+    func delayedGreet(name: String) async throws -> String {
+        try await Task.sleep(for: .seconds(1))
+        return try greet(name: name)
+    }
+}