* feat: compile example servers to JavaScript for npm consumption
Add TypeScript compilation for server code so the example packages can be
imported and used by consumers without requiring TypeScript compilation.
Changes:
- Add tsconfig.server.json to each example for compiling server code
- Update package.json exports to point to compiled dist/server/server.js
- Add types field pointing to dist/server/server.d.ts
- Update build scripts to include server compilation step
- Fix .ts import extensions to .js in customer-segmentation-server
This enables importing the createServer function from published packages:
import { createServer } from '@modelcontextprotocol/server-basic-react';
* fix: add type assertion for Nominatim API response
* chore: regenerate schemas
* refactor: split server examples into library and binary entry points
- server.ts: exports createServer() only (library entry point)
- main.ts: entry point with main() that runs the server (binary)
- package.json: adds bin field for npx support, uses inline bun build
- tsconfig.server.json: emitDeclarationOnly, outputs to dist/
This allows:
1. Importing the server as a library: import { createServer } from '@modelcontextprotocol/server-basic-react'
2. Running with npx: npx @modelcontextprotocol/server-basic-react [--stdio]
Added migration script at scripts/migrate-server-examples.ts
* refactor: migrate remaining server examples to library/binary structure
Apply the same refactoring to all 13 remaining server examples:
- scenario-modeler-server, shadertoy-server, map-server
- cohort-heatmap-server, customer-segmentation-server, video-resource-server
- system-monitor-server, budget-allocator-server, sheet-music-server
- threejs-server, integration-server, transcript-server, wiki-explorer-server
Each now has:
- server.ts: exports createServer() (library)
- main.ts: runs the server (binary with shebang)
- bin field in package.json for npx support
* chore: remove unused server-utils.ts from video-resource-server/src
* update
* fix(build): make Windows-compatible by removing chmod and fixing bun externals
- Remove 'chmod +x dist/index.js' which doesn't exist on Windows
- Add '--external ./server.js' to prevent bun from treating the import as a second entry point
* fix(build): use .ts import for bun compatibility
- Change import from './server.js' to './server.ts' in main.ts files
- Remove --external flag since bun should inline everything
- Fixes Windows build where bun couldn't resolve .js to .ts properly
* fix(build): use --external for Windows bun compatibility
Bun on Windows incorrectly treats imported .ts files as entry points.
Use --external './server.js' to work around this, creating a runtime
dependency between index.js and server.js.
* style: fix prettier formatting in pdf-server/main.ts
* fix(build): remove quotes from --external for Windows cmd.exe compatibility
* fix(build): use glob pattern for --external to work on all platforms
The literal path --external ./server.js was not matching the import.
Using glob pattern --external "./server*" correctly externalizes the server module.
* fix(build): use */server.js pattern for --external
The "./server*" pattern was not matching on Windows.
Using "*/server.js" matches any path ending in /server.js which works cross-platform.
* fix(build): use *server.js pattern without slash for Windows compatibility
* update package-lock
* chore: regenerate package-lock.json for cross-platform compatibility
* fix(build): use ./server.js instead of glob pattern for Windows compatibility
* fix(build): use double quotes for banner to fix Windows cmd.exe compatibility
---------
Co-authored-by: Olivier Chafik <ochafik@anthropic.com>
226 lines
6.2 KiB
TypeScript
226 lines
6.2 KiB
TypeScript
/**
|
|
* Three.js MCP Server
|
|
*
|
|
* Provides tools for rendering interactive 3D scenes using Three.js.
|
|
*/
|
|
import {
|
|
RESOURCE_MIME_TYPE,
|
|
registerAppResource,
|
|
registerAppTool,
|
|
} from "@modelcontextprotocol/ext-apps/server";
|
|
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
import type { ReadResourceResult } from "@modelcontextprotocol/sdk/types.js";
|
|
import fs from "node:fs/promises";
|
|
import path from "node:path";
|
|
import { z } from "zod";
|
|
|
|
const DIST_DIR = path.join(import.meta.dirname, "dist");
|
|
|
|
// Default code example for the Three.js widget
|
|
const DEFAULT_THREEJS_CODE = `const scene = new THREE.Scene();
|
|
const camera = new THREE.PerspectiveCamera(75, width / height, 0.1, 1000);
|
|
const renderer = new THREE.WebGLRenderer({ canvas, antialias: true });
|
|
renderer.setSize(width, height);
|
|
renderer.setClearColor(0x1a1a2e);
|
|
|
|
const cube = new THREE.Mesh(
|
|
new THREE.BoxGeometry(1, 1, 1),
|
|
new THREE.MeshStandardMaterial({ color: 0x00ff88 })
|
|
);
|
|
scene.add(cube);
|
|
|
|
scene.add(new THREE.DirectionalLight(0xffffff, 1));
|
|
scene.add(new THREE.AmbientLight(0x404040));
|
|
|
|
camera.position.z = 3;
|
|
|
|
function animate() {
|
|
requestAnimationFrame(animate);
|
|
cube.rotation.x += 0.01;
|
|
cube.rotation.y += 0.01;
|
|
renderer.render(scene, camera);
|
|
}
|
|
animate();`;
|
|
|
|
const THREEJS_DOCUMENTATION = `# Three.js Widget Documentation
|
|
|
|
## Available Globals
|
|
- \`THREE\` - Three.js library (r181)
|
|
- \`canvas\` - Pre-created canvas element
|
|
- \`width\`, \`height\` - Canvas dimensions in pixels
|
|
- \`OrbitControls\` - Interactive camera controls
|
|
- \`EffectComposer\`, \`RenderPass\`, \`UnrealBloomPass\` - Post-processing effects
|
|
|
|
## Basic Template
|
|
\`\`\`javascript
|
|
const scene = new THREE.Scene();
|
|
const camera = new THREE.PerspectiveCamera(75, width / height, 0.1, 1000);
|
|
const renderer = new THREE.WebGLRenderer({ canvas, antialias: true });
|
|
renderer.setSize(width, height);
|
|
renderer.setClearColor(0x1a1a2e); // Dark background
|
|
|
|
// Add objects here...
|
|
|
|
camera.position.z = 5;
|
|
renderer.render(scene, camera); // Static render
|
|
\`\`\`
|
|
|
|
## Example: Rotating Cube with Lighting
|
|
\`\`\`javascript
|
|
const scene = new THREE.Scene();
|
|
const camera = new THREE.PerspectiveCamera(75, width / height, 0.1, 1000);
|
|
const renderer = new THREE.WebGLRenderer({ canvas, antialias: true });
|
|
renderer.setSize(width, height);
|
|
renderer.setClearColor(0x1a1a2e);
|
|
|
|
const cube = new THREE.Mesh(
|
|
new THREE.BoxGeometry(1, 1, 1),
|
|
new THREE.MeshStandardMaterial({ color: 0x00ff88 })
|
|
);
|
|
scene.add(cube);
|
|
|
|
// Lighting - keep intensity at 1 or below
|
|
scene.add(new THREE.DirectionalLight(0xffffff, 1));
|
|
scene.add(new THREE.AmbientLight(0x404040));
|
|
|
|
camera.position.z = 3;
|
|
|
|
function animate() {
|
|
requestAnimationFrame(animate);
|
|
cube.rotation.x += 0.01;
|
|
cube.rotation.y += 0.01;
|
|
renderer.render(scene, camera);
|
|
}
|
|
animate();
|
|
\`\`\`
|
|
|
|
## Example: Interactive OrbitControls
|
|
\`\`\`javascript
|
|
const scene = new THREE.Scene();
|
|
const camera = new THREE.PerspectiveCamera(75, width / height, 0.1, 1000);
|
|
const renderer = new THREE.WebGLRenderer({ canvas, antialias: true });
|
|
renderer.setSize(width, height);
|
|
renderer.setClearColor(0x2d2d44);
|
|
|
|
const controls = new OrbitControls(camera, renderer.domElement);
|
|
controls.enableDamping = true;
|
|
|
|
const sphere = new THREE.Mesh(
|
|
new THREE.SphereGeometry(1, 32, 32),
|
|
new THREE.MeshStandardMaterial({ color: 0xff6b6b, roughness: 0.4 })
|
|
);
|
|
scene.add(sphere);
|
|
|
|
scene.add(new THREE.DirectionalLight(0xffffff, 1));
|
|
scene.add(new THREE.AmbientLight(0x404040));
|
|
|
|
camera.position.z = 4;
|
|
|
|
function animate() {
|
|
requestAnimationFrame(animate);
|
|
controls.update();
|
|
renderer.render(scene, camera);
|
|
}
|
|
animate();
|
|
\`\`\`
|
|
|
|
## Tips
|
|
- Always set \`renderer.setClearColor()\` to a dark color
|
|
- Keep light intensity ≤ 1 to avoid washed-out scenes
|
|
- Use \`MeshStandardMaterial\` for realistic lighting
|
|
- For animations, use \`requestAnimationFrame\`
|
|
`;
|
|
|
|
const resourceUri = "ui://threejs/mcp-app.html";
|
|
|
|
// =============================================================================
|
|
// Server Setup
|
|
// =============================================================================
|
|
|
|
/**
|
|
* Creates a new MCP server instance with tools and resources registered.
|
|
* Each HTTP session needs its own server instance because McpServer only supports one transport.
|
|
*/
|
|
export function createServer(): McpServer {
|
|
const server = new McpServer({
|
|
name: "Three.js Server",
|
|
version: "1.0.0",
|
|
});
|
|
|
|
// Tool 1: show_threejs_scene
|
|
registerAppTool(
|
|
server,
|
|
"show_threejs_scene",
|
|
{
|
|
title: "Show Three.js Scene",
|
|
description:
|
|
"Render an interactive 3D scene with custom Three.js code. Available globals: THREE, OrbitControls, EffectComposer, RenderPass, UnrealBloomPass, canvas, width, height.",
|
|
inputSchema: {
|
|
code: z
|
|
.string()
|
|
.default(DEFAULT_THREEJS_CODE)
|
|
.describe("JavaScript code to render the 3D scene"),
|
|
height: z
|
|
.number()
|
|
.int()
|
|
.positive()
|
|
.default(400)
|
|
.describe("Height in pixels"),
|
|
},
|
|
outputSchema: z.object({
|
|
code: z.string(),
|
|
height: z.number(),
|
|
}),
|
|
_meta: { ui: { resourceUri } },
|
|
},
|
|
async ({ code, height }) => {
|
|
const data = { code, height };
|
|
return {
|
|
content: [{ type: "text", text: JSON.stringify(data) }],
|
|
structuredContent: data,
|
|
};
|
|
},
|
|
);
|
|
|
|
// Tool 2: learn_threejs (not a UI tool, just returns documentation)
|
|
server.registerTool(
|
|
"learn_threejs",
|
|
{
|
|
title: "Learn Three.js",
|
|
description:
|
|
"Get documentation and examples for using the Three.js widget",
|
|
inputSchema: {},
|
|
},
|
|
async () => {
|
|
return {
|
|
content: [{ type: "text", text: THREEJS_DOCUMENTATION }],
|
|
};
|
|
},
|
|
);
|
|
|
|
// Resource registration
|
|
registerAppResource(
|
|
server,
|
|
resourceUri,
|
|
resourceUri,
|
|
{ mimeType: RESOURCE_MIME_TYPE, description: "Three.js Widget UI" },
|
|
async (): Promise<ReadResourceResult> => {
|
|
const html = await fs.readFile(
|
|
path.join(DIST_DIR, "mcp-app.html"),
|
|
"utf-8",
|
|
);
|
|
|
|
return {
|
|
contents: [
|
|
{
|
|
uri: resourceUri,
|
|
mimeType: RESOURCE_MIME_TYPE,
|
|
text: html,
|
|
},
|
|
],
|
|
};
|
|
},
|
|
);
|
|
|
|
return server;
|
|
}
|