iflow-mcp-hemanth-hello-remote 0.0.1

package/README.md

@@ -0,0 +1,113 @@
+# mcp-remote-server
+
+A Model Context Protocol (MCP) server built with mcp-framework.
+
+## Quick Start
+
+```bash
+# Install dependencies
+npm install
+
+# Build the project
+npm run build
+
+# Start the server
+npm start
+```
+
+The server will run on port **1947** at endpoint **/mcp** by default.
+
+## Project Structure
+
+```
+mcp-remote-server/
+├── src/
+│   ├── tools/                # MCP Tools
+│   │   └── XkcdTool.ts       # Tool: Fetches random xkcd comics
+│   ├── resources/            # MCP Resources
+│   │   ├── DynamicResource.ts  # Fetches data from JSONPlaceholder
+│   │   ├── RealTimeResource.ts # Echo WebSocket resource
+│   │   └── StaticResource.ts   # Returns static JSON data
+│   └── index.ts              # Server entry point
+├── package.json
+├── tsconfig.json
+└── README.md
+```
+
+## Included Tools
+
+### XkcdTool
+- **Name:** `xkcd`
+- **Description:** Fetches a random xkcd comic image and its alt text.
+
+## Included Resources
+
+### DynamicResource
+- **URI:** `resource://market-data`
+- **Description:** Fetches data from [JSONPlaceholder](https://jsonplaceholder.typicode.com/posts) (free, no API key required).
+
+### EchoResource
+- **URI:** `resource://echo`
+- **Description:** Connects to a public WebSocket echo server (`wss://echo.websocket.org`).
+
+### StaticResource
+- **URI:** `resource://static`
+- **Description:** Returns static JSON data for testing.
+
+## Adding Components
+
+You can add more tools using the CLI:
+
+```bash
+# Add a new tool
+mcp add tool my-tool
+```
+
+## Tool Development Example
+
+```typescript
+import { MCPTool } from "mcp-framework";
+import { z } from "zod";
+
+interface MyToolInput {
+  message: string;
+}
+
+class MyTool extends MCPTool<MyToolInput> {
+  name = "my_tool";
+  description = "Describes what your tool does";
+
+  schema = {
+    message: {
+      type: z.string(),
+      description: "Description of this input parameter",
+    },
+  };
+
+  async execute(input: MyToolInput) {
+    // Your tool logic here
+    return `Processed: ${input.message}`;
+  }
+}
+
+export default MyTool;
+```
+
+## Running and Testing
+
+1. Make changes to your tools or resources as needed.
+2. Run `npm run build` to compile.
+3. Start the server with `npm start`.
+4. The server will automatically load your tools and resources on startup.
+
+## Server Details
+- **Port:** 1947
+- **Endpoint:** `/mcp`
+- **Transport:** HTTP stream
+- **Session management:** Enabled
+- **CORS:** Enabled for all origins
+
+## Learn More
+
+- [MCP Framework Github](https://github.com/QuantGeekDev/mcp-framework)
+- [MCP Framework Docs](https://mcp-framework.com)

package/dist/index.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+import { MCPServer } from "mcp-framework";
+const server = new MCPServer({
+    transport: {
+        type: "stdio",
+    }
+});
+await server.start();

package/dist/prompts/GreetPrompt.js

@@ -0,0 +1,25 @@
+import { MCPPrompt } from "mcp-framework";
+import { z } from "zod";
+class GreetPrompt extends MCPPrompt {
+    name = "greet";
+    description = "Greet prompt description";
+    schema = {
+        message: z.object({
+            type: z.string(),
+            description: z.string(),
+            required: z.boolean(),
+        }),
+    };
+    async generateMessages({ message }) {
+        return [
+            {
+                role: "user",
+                content: {
+                    type: "text",
+                    text: `echo: ${message}`,
+                },
+            },
+        ];
+    }
+}
+export default GreetPrompt;

package/dist/resources/DynamicResource.js

@@ -0,0 +1,17 @@
+import { MCPResource } from "mcp-framework";
+class MarketDataResource extends MCPResource {
+    uri = "resource://market-data";
+    name = "Market Data";
+    mimeType = "application/json";
+    async read() {
+        const data = await this.fetch("https://jsonplaceholder.typicode.com/posts");
+        return [
+            {
+                uri: this.uri,
+                mimeType: this.mimeType,
+                text: JSON.stringify(data),
+            },
+        ];
+    }
+}
+export default MarketDataResource;

package/dist/resources/RealTimeResource.js

@@ -0,0 +1,33 @@
+import { MCPResource } from "mcp-framework";
+class EchoResource extends MCPResource {
+    uri = "resource://echo";
+    name = "Echo";
+    mimeType = "application/json";
+    ws = null;
+    async subscribe() {
+        this.ws = new WebSocket("wss://echo.websocket.org");
+        this.ws.onmessage = (event) => {
+            console.log('Received:', event.data);
+        };
+        // Send a test message
+        this.ws.onopen = () => {
+            this.ws?.send('Hello WebSocket!');
+        };
+    }
+    async unsubscribe() {
+        if (this.ws) {
+            this.ws.close();
+            this.ws = null;
+        }
+    }
+    async read() {
+        return [
+            {
+                uri: this.uri,
+                mimeType: this.mimeType,
+                text: 'Connected to WebSocket echo server'
+            },
+        ];
+    }
+}
+export default EchoResource;

package/dist/resources/StaticResource.js

@@ -0,0 +1,17 @@
+import { MCPResource } from "mcp-framework";
+class StaticResource extends MCPResource {
+    uri = "resource://static";
+    name = "Static";
+    description = "Static resource description";
+    mimeType = "application/json";
+    async read() {
+        return [
+            {
+                uri: this.uri,
+                mimeType: this.mimeType,
+                text: JSON.stringify({ message: "Hello from Static resource" }),
+            },
+        ];
+    }
+}
+export default StaticResource;

package/dist/tools/XkcdTool.js

@@ -0,0 +1,41 @@
+import { MCPTool } from "mcp-framework";
+import { z } from "zod";
+class XkcdTool extends MCPTool {
+    name = "xkcd";
+    description = "Fetches a random xkcd comic image and its alt text.";
+    schema = {
+        message: {
+            type: z.string(),
+            description: "Message to process",
+        },
+    };
+    async execute() {
+        try {
+            // Get the latest comic number
+            const latestComicResponse = await fetch("https://xkcd.com/info.0.json");
+            if (!latestComicResponse.ok) {
+                throw new Error(`Failed to fetch latest comic data: ${latestComicResponse.statusText}`);
+            }
+            const latestComicData = (await latestComicResponse.json());
+            const latestComicNumber = latestComicData.num;
+            // Generate a random comic number
+            const randomComicNumber = Math.floor(Math.random() * latestComicNumber) + 1;
+            // Fetch the random comic
+            const randomComicResponse = await fetch(`https://xkcd.com/${randomComicNumber}/info.0.json`);
+            if (!randomComicResponse.ok) {
+                throw new Error(`Failed to fetch comic data for ${randomComicNumber}: ${randomComicResponse.statusText}`);
+            }
+            const randomComicData = (await randomComicResponse.json());
+            return `
+        Title: ${randomComicData.title}
+        Image URL: ${randomComicData.img}
+        Alt Text: ${randomComicData.alt}
+      `;
+        }
+        catch (error) {
+            console.error("Error fetching xkcd comic:", error);
+            return "Error: Could not fetch xkcd comic.";
+        }
+    }
+}
+export default XkcdTool;

package/package.json

@@ -0,0 +1 @@
+{"name": "iflow-mcp-hemanth-hello-remote", "version": "0.0.1", "description": "mcp-remote-server MCP server", "type": "module", "bin": {"iflow-mcp-hemanth-hello-remote": "./dist/index.js"}, "files": ["dist"], "scripts": {"build": "tsc && mcp-build", "watch": "tsc --watch", "start": "node dist/index.js"}, "dependencies": {"mcp-framework": "^0.2.2"}, "devDependencies": {"@types/node": "^20.11.24", "typescript": "^5.3.3"}, "engines": {"node": ">=18.19.0"}}