Merge pull request #2 from ribeirogab/update-docs

feat: add class-based tool implementation for MCP server

Author: ribeirogab

README.md

@@ -24,7 +24,7 @@ import { z } from 'zod';
 // Create a server instance
 const server = new McpServer({ name: 'my-server' });
 
-// Add a tool
+// Register the tool with the server
 server.tool({
   name: 'greet',
   parameters: {
@@ -35,7 +35,7 @@ server.tool({
       content: [
         {
           type: 'text',
-          text: `Hello, ${name}!`
+          text: `Hello, ${name}! Nice to meet you.`
         }
       ]
     };
@@ -46,6 +46,47 @@ server.tool({
 server.start({ transportType: 'stdio' });
 ```
 
+## Class-based Implementation
+
+You can also implement MCP tools using classes:
+
+```typescript
+import { McpServer, type McpTool } from 'simple-mcp';
+import { z } from 'zod';
+
+const parameters = z.object({
+  name: z.string().describe('The name is required'),
+});
+
+class GreetTool implements McpTool<typeof parameters.shape> {
+  public readonly name = 'greet';
+  public readonly parameters = parameters.shape;
+
+  public async execute({ name }: z.infer<typeof parameters>) {
+    return {
+      content: [
+        {
+          type: 'text',
+          text: `Hello, ${name}! Nice to meet you.`,
+        },
+      ],
+    };
+  }
+}
+
+// Initialize a new MCP server with the name 'greet-server'
+const server = new McpServer({ name: 'greet-server' });
+
+// Create an instance of the GreetTool class
+const greetTool = new GreetTool();
+
+// Register the tool with the server
+server.tool(greetTool);
+
+// Start the server using stdio as the transport method
+server.start({ transportType: 'stdio' });
+```
+
 ## Examples
 
 Check out the [examples directory](https://github.com/ribeirogab/simple-mcp/tree/main/examples) for more complete examples:

examples/README.md

@@ -1,7 +1,6 @@
+import { McpServer, type McpTool } from 'simple-mcp';
 import { z } from 'zod';
 
-import { McpServer, type McpTool } from '../dist';
-
 // Initialize a new MCP server with the name 'calculator-server'
 const server = new McpServer({ name: 'calculator-server', version: '1.0.0' });
 

examples/calculator.ts

@@ -0,0 +1,45 @@
+import { McpServer, type McpTool } from 'simple-mcp';
+import { z } from 'zod';
+
+const parameters = z.object({
+  name: z.string().describe('The name is required'),
+});
+
+/**
+ * GreetTool class implements the McpTool interface
+ * This demonstrates how to create an MCP tool using a class-based approach
+ */
+class GreetTool implements McpTool<typeof parameters.shape> {
+  // Tool name
+  public readonly name = 'greet';
+
+  // Define parameters with Zod schema
+  public readonly parameters = parameters.shape;
+
+  /**
+   * Execute method that will be called when the tool is invoked
+   * @param request The validated request parameters
+   */
+  public async execute({ name }: z.infer<typeof parameters>) {
+    return {
+      content: [
+        {
+          type: 'text',
+          text: `Hello, ${name}! Nice to meet you.`,
+        },
+      ],
+    };
+  }
+}
+
+// Initialize a new MCP server with the name 'greet-server'
+const server = new McpServer({ name: 'greet-server' });
+
+// Create an instance of the GreetTool class
+const greetTool = new GreetTool();
+
+// Register the tool with the server
+server.tool(greetTool);
+
+// Start the server using stdio as the transport method
+server.start({ transportType: 'stdio' });

examples/greet-class.ts

@@ -1,7 +1,6 @@
+import { McpServer, type McpTool } from 'simple-mcp';
 import { z } from 'zod';
 
-import { McpServer, type McpTool } from '../dist';
-
 // Initialize a new MCP server with the name 'greet-server'
 const server = new McpServer({ name: 'greet-server' });
 

examples/greet.ts

@@ -49,6 +49,7 @@
     "eslint": "8.57.1",
     "eslint-plugin-simple-import-sort": "12.1.1",
     "prettier": "3.3.3",
+    "simple-mcp": "^0.0.1",
     "tsup": "^8.4.0",
     "typescript": "^5.8.2"
   }