Zum Inhalt springen

Quickstart

  • Node.js 22+ — pruefen mit node --version
  • npm — wird mit Node.js ausgeliefert
  1. FlowMCP Core installieren

    Erstelle ein neues Projekt und installiere die Core Library:

    Terminal-Fenster
    mkdir my-flowmcp-project
    cd my-flowmcp-project
    npm init -y
    npm install github:FlowMCP/flowmcp-core

    Fuege "type": "module" zu deiner package.json fuer ES-Module-Unterstuetzung hinzu.

  2. Ein Schema schreiben

    Erstelle eine Datei namens coingecko-ping.mjs:

    export const main = {
    namespace: 'coingecko',
    name: 'Ping',
    description: 'Check CoinGecko API server status',
    version: '3.0.0',
    root: 'https://api.coingecko.com/api/v3',
    requiredServerParams: [],
    requiredLibraries: [],
    headers: {},
    tools: {
    ping: {
    method: 'GET',
    path: '/ping',
    description: 'Check if CoinGecko API is online',
    parameters: [],
    output: {
    mimeType: 'application/json',
    schema: {
    type: 'object',
    properties: {
    gecko_says: { type: 'string', description: 'Response message' }
    }
    }
    }
    }
    }
    }

    Dieses Schema deklariert ein einzelnes Tool, das den CoinGecko-Ping-Endpoint aufruft. Kein API-Key erforderlich.

  3. Validieren und Aufrufen

    Erstelle eine Datei namens test.mjs:

    import { FlowMCP } from 'flowmcp-core'
    import { main } from './coingecko-ping.mjs'
    // Schema validieren
    const { status, messages } = FlowMCP.validateSchema( { schema: main } )
    console.log( status ? 'Schema valid!' : messages )
    // API aufrufen
    const result = await FlowMCP.fetch( {
    schema: main,
    routeName: 'ping',
    userParams: {},
    serverParams: {}
    } )
    console.log( result.dataAsString )
    // → {"gecko_says":"(V3) To the Moon!"}

    Ausfuehren:

    Terminal-Fenster
    node test.mjs

    Du solltest Schema valid! gefolgt von der CoinGecko-Ping-Antwort sehen.

  4. Als MCP Server starten

    Erstelle eine Datei namens server.mjs, um dein Schema als MCP Tool bereitzustellen:

    import { FlowMCP } from 'flowmcp-core'
    import { Server } from '@modelcontextprotocol/sdk/server/index.js'
    import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js'
    import { main } from './coingecko-ping.mjs'
    const server = new Server(
    { name: 'my-first-server', version: '1.0.0' },
    { capabilities: { tools: {} } }
    )
    FlowMCP.activateServerTools( { server, schemas: [main] } )
    const transport = new StdioServerTransport()
    await server.connect( transport )

    Installiere das MCP SDK:

    Terminal-Fenster
    npm install @modelcontextprotocol/sdk

    Starte den Server:

    Terminal-Fenster
    node server.mjs

    Dein MCP Server laeuft jetzt ueber stdio. KI-Clients wie Claude Desktop koennen sich verbinden und das coingecko__ping Tool aufrufen.

  1. Du hast einen API-Endpoint als Schema deklariert (kein Servercode noetig)
  2. FlowMCP hat die Schema-Struktur validiert
  3. FlowMCP hat die API mit korrekter URL-Konstruktion und Headern aufgerufen
  4. FlowMCP hat das Schema als MCP Tool mit automatisch generierter Zod-Validierung bereitgestellt

Das gleiche Muster funktioniert fuer jede REST API — fuege Authentifizierung via requiredServerParams und headers hinzu, Parameter via das parameters Array, Antwort-Transformation via den handlers Export.