Zum Inhalt springen

Installation

Docs > Getting Started
  • Node.js 22+ — erforderlich fuer ES-Module-Unterstuetzung und moderne JavaScript-Features
  • npm oder yarn — fuer Paketverwaltung

Node.js-Version pruefen:

Terminal-Fenster
node --version
# Muss v22.x oder hoeher sein

Die Core Library bietet Schema-Validierung, API-Ausfuehrung und MCP-Server-Aktivierung.

Install via GitHub:

npm install github:FlowMCP/flowmcp-core

FlowMCP packages are not published to NPM. They are installed directly from GitHub.

import { FlowMCP } from 'flowmcp-core'

Verwende FlowMCP Core wenn du:

  • Schemas programmatisch validieren willst
  • API-Aufrufe via FlowMCP.fetch() ausfuehren willst
  • MCP-Server mit FlowMCP.activateServerTools() bauen willst
  • FlowMCP in eigene Anwendungen integrieren willst

Das CLI bietet interaktiven Zugriff auf den vollstaendigen Schema-Katalog von der Kommandozeile.

Install via GitHub:

npm install -g github:FlowMCP/flowmcp-cli

FlowMCP packages are not published to NPM. They are installed directly from GitHub.

Installation verifizieren:

Terminal-Fenster
flowmcp status

Verwende das CLI wenn du:

  • Den Schema-Katalog durchsuchen willst (flowmcp search coingecko)
  • Schemas fuer ein Projekt aktivieren willst (flowmcp add coingecko_ping)
  • APIs direkt aufrufen willst (flowmcp call coingecko_ping '{}')
  • Schemas waehrend der Entwicklung validieren willst

373+ produktionsreife Schemas liegen dem CLI bei und decken Provider wie Etherscan, Moralis, DeFi Llama, Dune Analytics, OpenWeather, GitHub und viele mehr ab. Jedes Schema ist validiert, getestet und folgt der v4.1.0-Spezifikation.

Suche und aktiviere Schemas direkt aus dem CLI:

Terminal-Fenster
flowmcp search ethereum
# Zeigt passende Schemas mit Beschreibungen
flowmcp add get_contract_abi_etherscan
# Aktiviert das Schema und zeigt seine Parameter

Zum Erstellen von MCP-Servern brauchst du zusaetzlich das Model Context Protocol SDK:

Terminal-Fenster
npm install @modelcontextprotocol/sdk

Dies stellt die Klassen Server, StdioServerTransport und SSEServerTransport bereit, die benoetigt werden, um Schemas als MCP Tools bereitzustellen.

Erstelle eine Datei namens verify.mjs:

import { FlowMCP } from 'flowmcp-core'
const schema = {
namespace: 'test',
name: 'Verify',
description: 'Installation verification',
version: '4.1.0',
root: 'https://httpbin.org',
requiredServerParams: [],
requiredLibraries: [],
headers: {},
tools: {
check: {
method: 'GET',
path: '/get',
description: 'Simple GET request',
parameters: []
}
}
}
const { status } = FlowMCP.validateSchema( { schema } )
console.log( status ? 'FlowMCP Core installed successfully!' : 'Validation failed' )
Terminal-Fenster
node verify.mjs
# → FlowMCP Core installed successfully!
Terminal-Fenster
flowmcp status
# Zeigt Version, Konfiguration und aktive Tools
flowmcp search ping
# Sollte passende Schemas aus dem Katalog zurueckgeben

Fuer ein neues Projekt mit FlowMCP sieht eine minimale package.json so aus:

{
"name": "my-flowmcp-project",
"version": "1.0.0",
"type": "module",
"dependencies": {
"flowmcp-core": "github:FlowMCP/flowmcp-core",
"@modelcontextprotocol/sdk": "latest"
}
}