xmcp: ein TypeScript-Framework zum Erstellen und Verteilen von MCP-Anwendungen

xmcp ist ein TypeScript-basiertes Entwicklungsframework für die Erstellung und Verteilung von MCP (Model Context Protocol)-Anwendungen. xmcp vereinfacht den Entwicklungsprozess, indem es Entwicklern ermöglicht, schnell effiziente Tools zu erstellen und sie im MCP-Ökosystem einzusetzen. Es vereinfacht den Entwicklungsprozess, indem es Entwicklern ermöglicht, schnell effiziente Tools zu erstellen und sie im MCP-Ökosystem einzusetzen. xmcp konzentriert sich auf die Erfahrung der Entwickler und bietet Dateisystem-Routing, Hot-Reloading und flexible Middleware-Unterstützung. Mit seinen intuitiven Konfigurations- und Automatisierungstools können sowohl Anfänger als auch professionelle Entwickler schnell loslegen. Es unterstützt Plattformen wie Vercel und ist einfach zu implementieren und hoch kompatibel. Die offizielle Website bietet eine ausführliche Dokumentation für Entwickler, die sich mit der MCP-Entwicklung beschäftigen möchten.

Funktionsliste

• Auto-Registrierungs-Tool: vontoolsDas Verzeichnis erkennt und registriert die Werkzeugdateien automatisch.
• Dateisystem-Routing: Vereinfachen Sie die Entwicklung mit dateistrukturbasiertem Routing-Management.
• Hot Reloading: Sofortige Rückmeldung nach Codeänderungen zur Verbesserung der Entwicklungseffizienz.
• Middleware-Unterstützung: Bietet Authentifizierung und benutzerdefinierte Middleware zur Verbesserung der Funktionserweiterung.
• Flexible Konfiguration: durchxmcp.config.tsPassen Sie die Einstellungen des MCP-Servers an.
• Plattformübergreifende Bereitstellung: Unterstützung von Vercel und anderen Plattformen, einfache Bereitstellung und hohe Kompatibilität.
• Next.js und Express-Adapter: Nahtlose Integration in bestehende Projekte.
• Offizieller Dokumentations-Support: Bietet detaillierte Entwicklungs- und Einsatzrichtlinien.

Hilfe verwenden

Einbauverfahren

Der Installationsprozess von xmcp ist einfach und für Windows, macOS und Linux geeignet. Nachfolgend finden Sie die detaillierten Schritte:

1. Installation von Node.js
   Stellen Sie sicher, dass Node.js auf Ihrem System installiert ist (empfohlene Version 18 oder höher). Besuchen Sie die offizielle Node.js-Website, um es herunterzuladen und zu installieren. Führen Sie nach der Installation den folgenden Befehl aus, um die Version zu überprüfen:

   node -v
   npm -v
   

2. Ein Projekt erstellen
   Wählen Sie im Terminal ein Verzeichnis und führen Sie den folgenden Befehl aus, um das xmcp-Projekt zu initialisieren:

   npx create-xmcp@latest my-project
   

   Befehl erzeugt eine Datei namensmy-projectdes Projektordners, der die folgende Struktur enthält:

   my-project/
   ├── src/
   │   ├── middleware.ts    # 中间件处理HTTP请求/响应
   │   └── tools/           # 工具文件自动注册
   │       ├── greet.ts
   │       ├── search.ts
   ├── dist/                # 编译输出目录
   ├── package.json
   ├── tsconfig.json
   └── xmcp.config.ts       # xmcp配置文件
   

3. Installation von Abhängigkeiten
   Wechseln Sie in das Projektverzeichnis und installieren Sie die Abhängigkeiten:

   cd my-project
   npm install
   

4. Starten des Entwicklungsservers
   Führen Sie den folgenden Befehl aus, um den lokalen Entwicklungsserver zu starten:

   npm run dev
   

   Der Server läuft standardmäßig auf demhttp://localhost:3000. Öffnen Sie den Browser-Zugang, um die Anwendung anzuzeigen. Die Hot-Reload-Funktion spiegelt Codeänderungen in Echtzeit wider.

Hauptfunktionen

1. die Erstellung von Werkzeugen

xmcp bestandentoolsWerkzeug für die automatische Verzeichnisregistrierung. Der Entwickler muss lediglich diesrc/tools/Erstellen Sie TypeScript-Dateien unter. Erstellen Sie zum Beispiel ein Begrüßungstoolgreet.ts::

export default {
name: "greet",
description: "Returns a greeting message",
async handler(input: string) {
return `Hello, ${input}!`;
},
};

Nach dem Speichern wird das Tool automatisch registriert, ohne dass Sie es manuell konfigurieren müssen. Zuganghttp://localhost:3000/mcp?name=greetAbrufbar.

2. die Konfigurations-Middleware

Middleware wird zur Verarbeitung von HTTP-Anfragen und -Antworten verwendet, z. B. zur Authentifizierung oder Protokollierung. In dersrc/middleware.tsDefinieren Sie die Middleware in der

import { Middleware } from "xmcp";
export default function authMiddleware(): Middleware {
return async (req, res, next) => {
const authHeader = req.headers.authorization;
if (!authHeader) {
res.status(401).json({ error: "Unauthorized" });
return;
}
await next();
};
}

Die Middleware wird vor der Verarbeitung der Anfrage ausgeführt und eignet sich für das Hinzufügen benutzerdefinierter Logik.

3. benutzerdefinierte Konfiguration

passieren (eine Rechnung oder Inspektion etc.)xmcp.config.tsPassen Sie die Servereinstellungen an, z. B. Ports oder Werkzeugkataloge:

import { defineConfig } from "xmcp";
export default defineConfig({
port: 3001,
toolsDir: "src/tools",
middleware: ["authMiddleware"],
});

Ändern Sie den Server und starten Sie ihn neu, um die Konfiguration zu übernehmen.

4. der Einsatz in Vercel

xmcp unterstützt die Vercel-Ein-Klick-Bereitstellung. Stellen Sie sicher, dass das Projekt in das GitHub-Repository übertragen wird:

1. Melden Sie sich auf der offiziellen Vercel-Website an und verbinden Sie sich mit dem GitHub-Repository.
2. Wählen Sie das xmcp-Projekt aus, und Vercel wird die Konfiguration automatisch erkennen.
3. Klicken Sie auf die Schaltfläche "Bereitstellen" und warten Sie, bis die Bereitstellung abgeschlossen ist.
   Nach erfolgreicher Bereitstellung stellt Vercel eine öffentliche URL zur Verfügung, z. B.https://my-project.vercel.app.

Featured Function Bedienung

thermisches Umladen

Ändern Sie im Entwicklungsmodus dietoolsDie Dateien im Verzeichnis lösen einen automatischen Reload aus. Ein manueller Neustart des Servers ist nicht erforderlich, so dass er sich für schnelle Iterationen eignet. Zum Beispiel kann die Bearbeitung dergreet.tsin der Rückmeldung, speichern Sie sie und sehen Sie die Aktualisierung sofort in Ihrem Browser.

Dateisystem-Routing

xmcp gemäßtoolsDie Verzeichnisstruktur erzeugt automatisch Routen. Zum Beispiel.src/tools/search.tserzeugt/mcp?name=searchdes Routings. Die Entwickler müssen Routing-Tabellen nicht manuell konfigurieren, was die Verwaltung vereinfacht.

Next.js Integration

Wenn Sie bereits ein Next.js-Projekt haben, können Sie xmcp über einen Adapter integrieren. Installieren Sie xmcp im Next.js-Projekt:

npm install xmcp

daraufhinpages/api/mcp.tsHinzufügen:

import { createMcpHandler } from "xmcp/next";
export default createMcpHandler({
toolsDir: "src/tools",
});

Starten Sie die Next.js-Anwendung neu und die xmcp-Funktion kann in der/api/mcpPfad zu verwenden.

Anwendungsszenario

1. Schnelles Prototyping
   Entwickler können die Vorteile des Hot-Reloadings und des Dateisystem-Routings von xmcp nutzen, um schnell Prototypen von MCP-Tools zu erstellen. Um zum Beispiel ein Suchwerkzeug zu entwickeln, fügen Sie einfach dietoolsErgänzungen zum Katalogsearch.tsDie Funktion kann in wenigen Minuten getestet werden.
2. Entwicklung von API-Diensten
   xmcp ist für die Entwicklung von MCP-basierten API-Diensten geeignet. Authentifizierung und Protokollierung durch Middleware, kombiniert mit Vercel-Bereitstellung, geeignet für mobile oder Web-Anwendungen, um Back-End-Unterstützung zu bieten.
3. Integration von bestehenden Projekten
   Die Adapter von xmcp lassen sich nahtlos in bestehende Next.js oder Express-Projekte integrieren. Entwickler können MCP-Funktionalität hinzufügen, ohne bestehenden Code umzugestalten.
4. Bildung und Lernen
   Neulinge können TypeScript und MCP-Entwicklung mit xmcp erlernen. Seine intuitive Konfiguration und Dokumentation senkt die Lernschwelle für Anfänger zum Üben.

QA

1. Welche Programmiersprachen werden von xmcp unterstützt?
   xmcp wird hauptsächlich mit TypeScript entwickelt, aber die generierte MCP-Anwendung kann über HTTP aufgerufen werden, kompatibel mit jeder Sprache, die HTTP unterstützt.
2. Wie kann ich ein Tool debuggen?
   Führen Sie im Entwicklungsmodusnpm run devkönnen Sie das Protokoll der Terminalkonsole anzeigen. Fehler bei der Tool-Ausführung werden detailliert ausgegeben, so dass sich das Problem leicht lokalisieren lässt.
3. Unterstützt es die Authentifizierung mehrerer Benutzer?
   Ja, die Mehrbenutzer-Authentifizierung kann durch Middleware erreicht werden. Der Entwickler muss diemiddleware.tsImplementieren Sie die Authentifizierungslogik, z. B. durch die Überprüfung von JWT.
4. Ist die Bereitstellung auf einer Nicht-Vercel-Plattform machbar?
   möglich. xmcp unterstützt den plattformübergreifenden Einsatz durch einfaches Hinzufügen der kompiliertendistDas Verzeichnis wird auf eine Plattform hochgeladen, die Node.js unterstützt, z. B. AWS oder Heroku.