Install
pipx install awesome-okfFür wen
- Entwickler oder Agent-Nutzer, die einen AI agent den OKF-(Open Knowledge Format)-Ressourcenkatalog direkt abfragen lassen wollen: Der Katalog enthält OKF-bezogene Tools, Plugins, skills, Vorschläge und Dokumente.
- Personen, die bereits einen MCP-fähigen Client nutzen und mit Werkzeugen wie
search_catalogundget_catalog_entryprogrammatisch suchen wollen. - Personen, die eigene Inhalte in einen OKF-Katalog (Markdown-Dateien + YAML frontmatter) verwandeln und mit
myokf validateprüfen wollen.
Nicht geeignet, wenn:
- Sie keine OKF-Ressourcenfindung oder -umwandlung brauchen und nur Daten anderer Bereiche abfragen wollen.
- Sie README-Dateien direkt bearbeiten — offiziell sind README*.md erzeugt, dürfen nicht von Hand geändert werden; ändern Sie
data/catalog.yamlund erzeugen Sie neu. - Offiziell nicht beschriebene Punkte (unterstützte Client-Liste, Eingabesprachen der Umwandlung, konkrete Systemanforderungen) hier nicht geraten, sondern als unbestätigt markiert werden.
Erster Versuch in 3 Minuten
Voraussetzung: lokale Python-Umgebung mit installiertem pipx (offizieller Installationsweg). Es handelt sich um eine in Python umgesetzte CLI + MCP meta-server.
-
Installieren: im Terminal ausführen
pipx install awesome-okf -
Agent verbinden: Registrieren Sie den MCP server mit dem Befehl
awesome-okf-serverin Ihrem MCP-Client (offizielle Formulierung: "Connect it to your MCP client"; genaue Registrierungspfade je Client stehen nicht in der Evidenz, folgen Sie der Client-Dokumentation). -
Eine risikoarme, nur lesende Aufgabe anstoßen: Sagen Sie dem Agenten „nutze search_catalog, suche im Katalog nach OKF-Tools und gib die ersten Einträge zurück“. Das Werkzeug akzeptiert query/kind/limit, ist eine Katalogabfrage und schreibt nicht.
Erfolgssignal: Der Agent liefert Katalogeinträge (auf Basis von get_catalog_entry / list_catalog) oder catalog_stats-Kennzahlen — der meta-server ist verbunden.
Hinweis: Der erste Versuch darf nur abfragen. convert_to_okf und scripts/convert-to-okf.py erzeugen OKF-Katalogdateien und schreiben auf die Platte. Führen Sie sie erst aus, wenn der Zielpfad klar ist und Sie wissen, dass Markdown + YAML frontmatter-Dateien entstehen.
Anwendungsfälle
Fall 1: Den Agenten OKF-Ressourcen finden lassen. Szenario: Sie wollen wissen, welche Tools oder Skills im OKF-Ökosystem verfügbar sind. Bitten Sie den verbundenen Agenten: „nutze search_catalog, setze query auf Ihre Suchwörter, filtere optional nach kind, begrenze mit limit“. Der Agent ruft das Suchwerkzeug des meta-server auf und gibt passende Tools/Plugins/skills/Vorschläge/Dokumente zurück; Kennzahlen liefert catalog_stats. Reine Abfrage; das Ergebnis sind die Katalogeinträge selbst.
Fall 2: Vorhandene Inhalte in einen OKF-Katalog verwandeln. Szenario: Sie haben strukturierten Text (Listen, JSON, Schlüssel-Wert-Paare, URL-Listen) und wollen ein agent-taugliches Wissensformat. Nutzen Sie scripts/convert-to-okf.py; der Modus --format anything probiert die Parserkette (list → JSON → key-value → URLs → line-per-row), bis ein Parser greift. Bestätigbares Ergebnis: ein Katalog aus Markdown-Dateien mit YAML frontmatter, anschließend prüfbar mit myokf validate. Nebenwirkung: Dieser Schritt schreibt Dateien auf die Platte; die Umwandlung läuft lokal. Prüfen Sie zuerst das Ausgabeverzeichnis. Nicht durch Evidenz abgedeckt: ob der MCP-Toolaufruf convert_to_okf dieselbe Umwandlung leistet, und das genaue Fehlerverhalten bei Misserfolg.
Nutzungsgrenzen
- README*.md nicht direkt bearbeiten: Sie sind Erzeugnisse. Einträge ändern Sie in
data/catalog.yamlund erzeugen neu; offiziell müssen Einträge vor dem Einsendenawesome-okf validateund pytest bestehen. - Netz-/Dateizugriff: Die Umwandlung nutzt eine lokale Engine (extraction done by local engines only) und holt nichts von außen. Das Netzverhalten des meta-server selbst ist offiziell nicht beschrieben und gilt als unbekannt.
- Zuerst prüfen: Jede schreibende Aktion (Umwandlung, Erzeugung) soll zuerst den Zielpfad bestätigen. Abfragewerkzeuge (search_catalog, list_catalog, get_catalog_entry, catalog_stats) lesen den Katalog, aber für die absolute Sicherheitsaussage „schreibt keine Dateien und führt keine Befehle aus“ reicht die Evidenz nicht; diese Seite behauptet das nicht.
- Laufzeit: in Python umgesetzte CLI und MCP meta-server via pipx; ein MCP-fähiger Client ist nötig. Offiziell ist nicht aufgeführt, welche MCP-Clients unterstützt werden.
- Unbestätigt: unterstützter Umfang natürlicher Sprachen, Registrierungsdetails je MCP-Client und Versionen der Systemabhängigkeiten stehen nicht im offiziellen Text. Lesen Sie vor der Nutzung die aktuellen Repository-Dokumente.