Merge pull request #638 from getmaxun/mcp

feat: MCP server support
This commit is contained in:
Karishma Shukla
2025-06-24 16:25:31 +05:30
committed by GitHub
4 changed files with 407 additions and 11 deletions

View File

@@ -99,7 +99,8 @@
"migrate:undo:all": "sequelize-cli db:migrate:undo:all",
"seed": "sequelize-cli db:seed:all",
"seed:undo:all": "sequelize-cli db:seed:undo:all",
"migration:generate": "sequelize-cli migration:generate --name"
"migration:generate": "sequelize-cli migration:generate --name",
"mcp:build": "tsc --project server/tsconfig.mcp.json"
},
"eslintConfig": {
"extends": [
@@ -107,6 +108,7 @@
]
},
"devDependencies": {
"@modelcontextprotocol/sdk": "^1.12.1",
"@types/connect-pg-simple": "^7.0.3",
"@types/cookie-parser": "^1.4.7",
"@types/express": "^4.17.13",
@@ -115,6 +117,7 @@
"@types/loglevel": "^1.6.3",
"@types/node": "22.7.9",
"@types/node-cron": "^3.0.11",
"@types/node-fetch": "^2.6.12",
"@types/prismjs": "^1.26.0",
"@types/react-highlight": "^0.12.5",
"@types/react-transition-group": "^4.4.4",
@@ -129,6 +132,7 @@
"nodemon": "^2.0.15",
"sequelize-cli": "^6.6.2",
"ts-node": "^10.4.0",
"vite": "^5.4.10"
"vite": "^5.4.10",
"zod": "^3.25.62"
}
}

373
server/src/mcp-worker.ts Normal file
View File

@@ -0,0 +1,373 @@
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
import { z } from "zod";
import fetch from 'node-fetch';
import dotenv from 'dotenv';
dotenv.config();
const log = (message: string) => {
if (process.env.NODE_ENV !== 'production') {
console.error(`[MCP Worker] ${message}`);
}
};
class MaxunMCPWorker {
private mcpServer: McpServer;
private apiKey: string;
private apiUrl: string;
constructor() {
this.apiKey = process.env.MCP_API_KEY || '';
this.apiUrl = process.env.BACKEND_URL || 'http://localhost:8080';
if (!this.apiKey) {
throw new Error('MCP_API_KEY environment variable is required');
}
this.mcpServer = new McpServer({
name: 'Maxun Web Scraping Server',
version: '1.0.0'
});
this.setupTools();
}
private async makeApiRequest(endpoint: string, options: any = {}) {
const url = `${this.apiUrl}${endpoint}`;
const headers = {
'Content-Type': 'application/json',
'x-api-key': this.apiKey,
...options.headers
};
const response = await fetch(url, {
...options,
headers
});
if (!response.ok) {
throw new Error(`API request failed: ${response.status} ${response.statusText}`);
}
return await response.json();
}
private setupTools() {
// Tool: List all robots
this.mcpServer.tool(
"list_robots",
{},
async () => {
try {
const data = await this.makeApiRequest('/api/robots');
return {
content: [{
type: "text",
text: `Found ${data.robots.totalCount} robots:\n\n${JSON.stringify(data.robots.items, null, 2)}`
}]
};
} catch (error: any) {
return {
content: [{
type: "text",
text: `Error fetching robots: ${error.message}`
}],
isError: true
};
}
}
);
// Tool: Get robot details by ID
this.mcpServer.tool(
"get_robot",
{
robot_id: z.string().describe("ID of the robot to get details for")
},
async ({ robot_id }: { robot_id: string }) => {
try {
const data = await this.makeApiRequest(`/api/robots/${robot_id}`);
return {
content: [{
type: "text",
text: `Robot Details:\n\n${JSON.stringify(data.robot, null, 2)}`
}]
};
} catch (error: any) {
return {
content: [{
type: "text",
text: `Error fetching robot: ${error.message}`
}],
isError: true
};
}
}
);
// Tool: Run a robot and get results
this.mcpServer.tool(
"run_robot",
{
robot_id: z.string().describe("ID of the robot to run"),
wait_for_completion: z.boolean().default(true).describe("Whether to wait for the run to complete")
},
async ({ robot_id, wait_for_completion }: { robot_id: string; wait_for_completion: boolean }) => {
try {
const data = await this.makeApiRequest(`/api/robots/${robot_id}/runs`, {
method: 'POST'
});
if (wait_for_completion) {
const extractedData = data.run.data;
const screenshots = data.run.screenshots;
let resultText = `Robot run completed successfully!\n\n`;
resultText += `Run ID: ${data.run.runId}\n`;
resultText += `Status: ${data.run.status}\n`;
resultText += `Started: ${data.run.startedAt}\n`;
resultText += `Finished: ${data.run.finishedAt}\n\n`;
if (extractedData.textData && extractedData.textData.length > 0) {
resultText += `Extracted Text Data (${extractedData.textData.length} items):\n`;
resultText += JSON.stringify(extractedData.textData, null, 2) + '\n\n';
}
if (extractedData.listData && extractedData.listData.length > 0) {
resultText += `Extracted List Data (${extractedData.listData.length} items):\n`;
resultText += JSON.stringify(extractedData.listData, null, 2) + '\n\n';
}
if (screenshots && screenshots.length > 0) {
resultText += `Screenshots captured: ${screenshots.length}\n`;
resultText += `Screenshot URLs:\n`;
screenshots.forEach((screenshot: any, index: any) => {
resultText += `${index + 1}. ${screenshot}\n`;
});
}
return {
content: [{
type: "text",
text: resultText
}]
};
} else {
return {
content: [{
type: "text",
text: `Robot run started! Run ID: ${data.run.runId}\nStatus: ${data.run.status}`
}]
};
}
} catch (error: any) {
return {
content: [{
type: "text",
text: `Error running robot: ${error.message}`
}],
isError: true
};
}
}
);
// Tool: Get all runs for a robot
this.mcpServer.tool(
"get_robot_runs",
{
robot_id: z.string().describe("ID of the robot")
},
async ({ robot_id }: { robot_id: string }) => {
try {
const data = await this.makeApiRequest(`/api/robots/${robot_id}/runs`);
return {
content: [{
type: "text",
text: `Robot runs (${data.runs.totalCount} total):\n\n${JSON.stringify(data.runs.items, null, 2)}`
}]
};
} catch (error: any) {
return {
content: [{
type: "text",
text: `Error fetching runs: ${error.message}`
}],
isError: true
};
}
}
);
// Tool: Get specific run details
this.mcpServer.tool(
"get_run_details",
{
robot_id: z.string().describe("ID of the robot"),
run_id: z.string().describe("ID of the specific run")
},
async ({ robot_id, run_id }: { robot_id: string; run_id: string }) => {
try {
const data = await this.makeApiRequest(`/api/robots/${robot_id}/runs/${run_id}`);
const run = data.run;
let resultText = `Run Details:\n\n`;
resultText += `Run ID: ${run.runId}\n`;
resultText += `Status: ${run.status}\n`;
resultText += `Robot ID: ${run.robotId}\n`;
resultText += `Started: ${run.startedAt}\n`;
resultText += `Finished: ${run.finishedAt}\n\n`;
if (run.data.textData && run.data.textData.length > 0) {
resultText += `Extracted Text Data:\n${JSON.stringify(run.data.textData, null, 2)}\n\n`;
}
if (run.data.listData && run.data.listData.length > 0) {
resultText += `Extracted List Data:\n${JSON.stringify(run.data.listData, null, 2)}\n\n`;
}
if (run.screenshots && run.screenshots.length > 0) {
resultText += `Screenshots:\n`;
run.screenshots.forEach((screenshot: any, index: any) => {
resultText += `${index + 1}. ${screenshot}\n`;
});
}
return {
content: [{
type: "text",
text: resultText
}]
};
} catch (error: any) {
return {
content: [{
type: "text",
text: `Error fetching run details: ${error.message}`
}],
isError: true
};
}
}
);
// Tool: Get robot performance summary
this.mcpServer.tool(
"get_robot_summary",
{
robot_id: z.string().describe("ID of the robot")
},
async ({ robot_id }: { robot_id: string }) => {
try {
const [robotData, runsData] = await Promise.all([
this.makeApiRequest(`/api/robots/${robot_id}`),
this.makeApiRequest(`/api/robots/${robot_id}/runs`)
]);
const robot = robotData.robot;
const runs = runsData.runs.items;
const successfulRuns = runs.filter((run: any) => run.status === 'success');
const failedRuns = runs.filter((run: any) => run.status === 'failed');
let totalTextItems = 0;
let totalListItems = 0;
let totalScreenshots = 0;
successfulRuns.forEach((run: any) => {
if (run.data.textData) totalTextItems += run.data.textData.length;
if (run.data.listData) totalListItems += run.data.listData.length;
if (run.screenshots) totalScreenshots += run.screenshots.length;
});
const summary = `Robot Performance Summary:
Robot Name: ${robot.name}
Robot ID: ${robot.id}
Created: ${robot.createdAt ? new Date(robot.createdAt).toLocaleString() : 'N/A'}
Performance Metrics:
- Total Runs: ${runs.length}
- Successful Runs: ${successfulRuns.length}
- Failed Runs: ${failedRuns.length}
- Success Rate: ${runs.length > 0 ? ((successfulRuns.length / runs.length) * 100).toFixed(1) : 0}%
Data Extracted:
- Total Text Items: ${totalTextItems}
- Total List Items: ${totalListItems}
- Total Screenshots: ${totalScreenshots}
- Total Data Points: ${totalTextItems + totalListItems}
Input Parameters:
${JSON.stringify(robot.inputParameters, null, 2)}`;
return {
content: [{
type: "text",
text: summary
}]
};
} catch (error: any) {
return {
content: [{
type: "text",
text: `Error generating robot summary: ${error.message}`
}],
isError: true
};
}
}
);
}
async start() {
try {
const transport = new StdioServerTransport();
await this.mcpServer.connect(transport);
log('Maxun MCP Worker connected and ready');
} catch (error: any) {
log(`Failed to start MCP Worker: ${error.message}`);
throw error;
}
}
async stop() {
try {
await this.mcpServer.close();
log('Maxun MCP Worker stopped');
} catch (error: any) {
log(`Error stopping MCP Worker: ${error.message}`);
}
}
}
async function main() {
try {
const worker = new MaxunMCPWorker();
await worker.start();
// Handle graceful shutdown
process.on('SIGTERM', async () => {
await worker.stop();
process.exit(0);
});
process.on('SIGINT', async () => {
await worker.stop();
process.exit(0);
});
} catch (error) {
console.error('Failed to start MCP Worker:', error);
process.exit(1);
}
}
// Only start if this is run as a worker or directly
if (process.env.MCP_WORKER === 'true' || require.main === module) {
main();
}

View File

@@ -84,9 +84,6 @@ export const io = new Server(server);
*/
export const browserPool = new BrowserPool();
// app.use(bodyParser.json({ limit: '10mb' }))
// app.use(bodyParser.urlencoded({ extended: true, limit: '10mb', parameterLimit: 9000 }));
// parse cookies - "cookie" is true in csrfProtection
app.use(cookieParser())
app.use('/webhook', webhook);
@@ -100,9 +97,9 @@ app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpec));
readdirSync(path.join(__dirname, 'api')).forEach((r) => {
const route = require(path.join(__dirname, 'api', r));
const router = route.default || route; // Use .default if available, fallback to route
const router = route.default || route;
if (typeof router === 'function') {
app.use('/api', router); // Use the default export or named router
app.use('/api', router);
} else {
console.error(`Error: ${r} does not export a valid router`);
}
@@ -152,7 +149,6 @@ app.get('/', function (req, res) {
return res.send('Maxun server started 🚀');
});
// Add CORS headers
app.use((req, res, next) => {
res.header('Access-Control-Allow-Origin', process.env.PUBLIC_URL || 'http://localhost:5173');
res.header('Access-Control-Allow-Methods', 'GET,PUT,POST,DELETE,OPTIONS');
@@ -175,7 +171,7 @@ server.listen(SERVER_PORT, '0.0.0.0', async () => {
logger.log('info', `Server listening on port ${SERVER_PORT}`);
} catch (error: any) {
logger.log('error', `Failed to connect to the database: ${error.message}`);
process.exit(1); // Exit the process if DB connection fails
process.exit(1);
}
});

23
server/tsconfig.mcp.json Normal file
View File

@@ -0,0 +1,23 @@
{
"compilerOptions": {
"target": "ES2022",
"module": "Node16",
"moduleResolution": "Node16",
"outDir": "../dist",
"rootDir": "./src",
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"forceConsistentCasingInFileNames": true,
"declaration": true,
"declarationMap": true,
"sourceMap": true
},
"include": [
"src/mcp-worker.ts"
],
"exclude": [
"node_modules",
"dist"
]
}