Merge pull request #56 from doitintl/feature/talc/sse-server

feat(mcp): add sse transport server

Author: taltultc

README.md

@@ -2,7 +2,6 @@
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) ![NPM Version](https://img.shields.io/npm/v/%40doitintl%2Fdoit-mcp-server?registry_uri=https%3A%2F%2Fregistry.npmjs.com%2F%40doitintl%2Fdoit-mcp-server)
 
-
 DoiT MCP Server provides access to the DoiT API. This server enables LLMs like Claude to access DoiT platform data for troubleshooting and analysis.
 
 ![top-services](https://github.com/user-attachments/assets/749dd237-3021-439d-b447-64605393389d)
@@ -11,14 +10,32 @@ DoiT MCP Server provides access to the DoiT API. This server enables LLMs like C
 
 - Node.js v18 or higher
 - DoiT API key with appropriate permissions
-- Customer context identifier (for customer-specific data)
 
 ## Installation
 
 To get your DoiT API key, visit the [API key section in your DoiT profile](https://help.doit.com/docs/general/profile#api-key).
 
 There are several ways to install and configure the MCP server:
 
+### DoiT MCP URL
+
+The DoiT MCP server is available at: https://mcp.doit.com/sse
+
+### Claude Desktop App
+
+```json
+{
+  "mcpServers": {
+    "doit_mcp_server": {
+      "command": "npx",
+      "args": ["mcp-remote", "https://mcp.doit.com/sse"]
+    }
+  }
+}
+```
+
+## STDIO - local server
+
 ### Claude Desktop App
 
 To manually configure the MCP server for Claude Desktop App, add the following to your `claude_desktop_config.json` file or through "Settings" as described [here](https://modelcontextprotocol.io/quickstart/user#2-add-the-filesystem-mcp-server):

doit-mcp-server/.gitignore

@@ -0,0 +1,178 @@
+node_modules
+
+.nx
+.idea
+.vscode
+.zed
+# Logs
+
+logs
+_.log
+npm-debug.log_
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+
+report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
+
+# Runtime data
+
+pids
+_.pid
+_.seed
+\*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+
+lib-cov
+
+# Coverage directory used by tools like istanbul
+
+coverage
+\*.lcov
+
+# nyc test coverage
+
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+
+bower_components
+
+# node-waf configuration
+
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+
+build/Release
+
+# Dependency directories
+
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+
+web_modules/
+
+# TypeScript cache
+
+\*.tsbuildinfo
+
+# Optional npm cache directory
+
+.npm
+
+# Optional eslint cache
+
+.eslintcache
+
+# Optional stylelint cache
+
+.stylelintcache
+
+# Microbundle cache
+
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+
+.node_repl_history
+
+# Output of 'npm pack'
+
+\*.tgz
+
+# Yarn Integrity file
+
+.yarn-integrity
+
+# dotenv environment variable files
+
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+
+.cache
+.parcel-cache
+
+# Next.js build output
+
+.next
+out
+
+# Nuxt.js build / generate output
+
+.nuxt
+dist
+
+# Gatsby files
+
+.cache/
+
+# Comment in the public line in if your project uses Gatsby and not Next.js
+
+# https://nextjs.org/blog/next-9-1#public-directory-support
+
+# public
+
+# vuepress build output
+
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+
+.temp
+.cache
+
+# Docusaurus cache and generated files
+
+.docusaurus
+
+# Serverless directories
+
+.serverless/
+
+# FuseBox cache
+
+.fusebox/
+
+# DynamoDB Local files
+
+.dynamodb/
+
+# TernJS port file
+
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+
+.vscode-test
+
+# yarn v2
+
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.\*
+
+# wrangler project
+
+.dev.vars
+.wrangler/

doit-mcp-server/README.md

@@ -0,0 +1,120 @@
+# Remote MCP Server on Cloudflare
+
+Let's get a remote MCP server up-and-running on Cloudflare Workers complete with OAuth login!
+
+## Develop locally
+
+```bash
+# clone the repository
+git clone https://github.com/cloudflare/ai.git
+# Or if using ssh:
+# git clone git@github.com:cloudflare/ai.git
+
+# install dependencies
+cd ai
+# Note: using pnpm instead of just "npm"
+pnpm install
+
+# run locally
+npx nx dev remote-mcp-server
+```
+
+You should be able to open [`http://localhost:8787/`](http://localhost:8787/) in your browser
+
+## Connect the MCP inspector to your server
+
+To explore your new MCP api, you can use the [MCP Inspector](https://modelcontextprotocol.io/docs/tools/inspector).
+
+- Start it with `npx @modelcontextprotocol/inspector`
+- [Within the inspector](http://localhost:5173), switch the Transport Type to `SSE` and enter `http://localhost:8787/sse` as the URL of the MCP server to connect to, and click "Connect"
+- You will navigate to a (mock) user/password login screen. Input any email and pass to login.
+- You should be redirected back to the MCP Inspector and you can now list and call any defined tools!
+
+<div align="center">
+  <img src="img/mcp-inspector-sse-config.png" alt="MCP Inspector with the above config" width="600"/>
+</div>
+
+<div align="center">
+  <img src="img/mcp-inspector-successful-tool-call.png" alt="MCP Inspector with after a tool call" width="600"/>
+</div>
+
+## Connect Claude Desktop to your local MCP server
+
+The MCP inspector is great, but we really want to connect this to Claude! Follow [Anthropic's Quickstart](https://modelcontextprotocol.io/quickstart/user) and within Claude Desktop go to Settings > Developer > Edit Config to find your configuration file.
+
+Open the file in your text editor and replace it with this configuration:
+
+```json
+{
+  "mcpServers": {
+    "math": {
+      "command": "npx",
+      "args": [
+        "mcp-remote",
+        "http://localhost:8787/sse"
+      ]
+    }
+  }
+}
+```
+
+This will run a local proxy and let Claude talk to your MCP server over HTTP
+
+When you open Claude a browser window should open and allow you to login. You should see the tools available in the bottom right. Given the right prompt Claude should ask to call the tool.
+
+<div align="center">
+  <img src="img/available-tools.png" alt="Clicking on the hammer icon shows a list of available tools" width="600"/>
+</div>
+
+<div align="center">
+  <img src="img/claude-does-math-the-fancy-way.png" alt="Claude answers the prompt 'I seem to have lost my calculator and have run out of fingers. Could you use the math tool to add 23 and 19?' by invoking the MCP add tool" width="600"/>
+</div>
+
+## Deploy to Cloudflare
+
+1. `npx wrangler kv namespace create OAUTH_KV`
+2. Follow the guidance to add the kv namespace ID to `wrangler.jsonc`
+3. `npm run deploy`
+
+## Call your newly deployed remote MCP server from a remote MCP client
+
+Just like you did above in "Develop locally", run the MCP inspector:
+
+`npx @modelcontextprotocol/inspector@latest`
+
+Then enter the `workers.dev` URL (ex: `worker-name.account-name.workers.dev/sse`) of your Worker in the inspector as the URL of the MCP server to connect to, and click "Connect".
+
+You've now connected to your MCP server from a remote MCP client.
+
+## Connect Claude Desktop to your remote MCP server
+
+Update the Claude configuration file to point to your `workers.dev` URL (ex: `worker-name.account-name.workers.dev/sse`) and restart Claude 
+
+```json
+{
+  "mcpServers": {
+    "math": {
+      "command": "npx",
+      "args": [
+        "mcp-remote",
+        "https://worker-name.account-name.workers.dev/sse"
+      ]
+    }
+  }
+}
+```
+
+## Debugging
+
+Should anything go wrong it can be helpful to restart Claude, or to try connecting directly to your
+MCP server on the command line with the following command.
+
+```bash
+npx mcp-remote http://localhost:8787/sse
+```
+
+In some rare cases it may help to clear the files added to `~/.mcp-auth`
+
+```bash
+rm -rf ~/.mcp-auth
+```

doit-mcp-server/biome.json

@@ -0,0 +1,49 @@
+{
+	"$schema": "https://biomejs.dev/schemas/2.0.4/schema.json",
+	"assist": {
+		"actions": {
+			"source": {
+				"useSortedKeys": "on"
+			}
+		},
+		"enabled": true
+	},
+	"files": {
+		"includes": ["!worker-configuration.d.ts"]
+	},
+	"formatter": {
+		"enabled": true,
+		"indentWidth": 4,
+		"lineWidth": 100
+	},
+	"linter": {
+		"enabled": true,
+		"rules": {
+			"recommended": true,
+			"style": {
+				"noInferrableTypes": "error",
+				"noNonNullAssertion": "off",
+				"noParameterAssign": "error",
+				"noUnusedTemplateLiteral": "error",
+				"noUselessElse": "error",
+				"useAsConstAssertion": "error",
+				"useDefaultParameterLast": "error",
+				"useEnumInitializers": "error",
+				"useNumberNamespace": "error",
+				"useSelfClosingElements": "error",
+				"useSingleVarDeclarator": "error"
+			},
+			"suspicious": {
+				"noConfusingVoidType": "off",
+				"noDebugger": "off",
+				"noExplicitAny": "off"
+			}
+		}
+	},
+	"root": false,
+	"vcs": {
+		"clientKind": "git",
+		"enabled": true,
+		"useIgnoreFile": true
+	}
+}