Install
pipx install awesome-okfPour qui
- Développeurs ou utilisateurs d'agent qui veulent qu'un AI agent interroge directement le catalogue de ressources OKF (Open Knowledge Format) : le catalogue contient des outils, plugins, skills, propositions et documents liés à OKF.
- Personnes déjà sur un client compatible MCP qui veulent une recherche programmatique avec des outils comme
search_catalogetget_catalog_entry. - Personnes qui veulent transformer leur contenu en catalogue OKF (fichiers Markdown + YAML frontmatter) et le vérifier avec
myokf validate.
Cas où ce n'est pas adapté :
- Situations sans besoin de découverte ou de conversion de ressources OKF, où l'on veut seulement interroger d'autres domaines.
- Éditeurs directs du README — le texte officiel indique que les fichiers README*.md sont générés, qu'il ne faut pas les modifier à la main, et qu'il faut changer
data/catalog.yamlpuis régénérer. - Les points non décrits officiellement (liste des clients pris en charge, langues d'entrée de la conversion, exigences système concrètes) ne sont pas devinés ici ; ils sont marqués non confirmés.
Premier essai en 3 minutes
Prérequis : un environnement Python local avec pipx installé (méthode d'installation officielle). Il s'agit d'une CLI + MCP meta-server implémentée en Python.
-
Installer : exécuter dans un terminal
pipx install awesome-okf -
Connecter l'agent : enregistrez le MCP server auprès de votre client MCP avec la commande
awesome-okf-server(formulation officielle : "Connect it to your MCP client" ; les chemins d'enregistrement par client ne figurent pas dans les preuves, suivez la documentation de votre client). -
Lancer une tâche en lecture seule à faible risque : dites à l'agent « utilise search_catalog pour chercher les outils OKF du catalogue et renvoie les premières entrées ». L'outil accepte query/kind/limit, interroge le catalogue et n'écrit pas.
Signal de succès : l'agent renvoie des entrées de catalogue (d'après get_catalog_entry / list_catalog) ou des totaux catalog_stats — le meta-server est joignable.
Note : le premier essai doit seulement interroger. convert_to_okf et scripts/convert-to-okf.py créent des fichiers de catalogue OKF et écrivent sur le disque. Ne les lancez qu'après avoir confirmé le chemin cible et su qu'ils produiront des fichiers Markdown + YAML frontmatter.
Cas d'usage
Cas 1 : faire chercher des ressources OKF par l'agent. Scénario : vous voulez savoir quels outils ou compétences existent dans l'écosystème OKF. Demandez à l'agent connecté : « utilise search_catalog, mets tes mots-clés dans query, filtre éventuellement par kind, limite avec limit ». L'agent appelle l'outil de recherche du meta-server et renvoie les outils/plugins/skills/propositions/documents correspondants ; les totaux passent par catalog_stats. Interrogation pure ; le résultat est l'entrée de catalogue elle-même.
Cas 2 : transformer un contenu existant en catalogue OKF. Scénario : vous avez du texte structuré (listes, JSON, paires clé-valeur, listes d'URL) et voulez un format de connaissance adapté à un agent. Utilisez scripts/convert-to-okf.py ; le mode --format anything essaie la chaîne d'analyse (list → JSON → key-value → URLs → line-per-row) jusqu'à ce qu'un analyseur réussisse. Résultat confirmable : un catalogue de fichiers Markdown avec YAML frontmatter, ensuite vérifiable avec myokf validate. Effet de bord : cette étape écrit des fichiers sur le disque ; la conversion est faite par un moteur local. Confirmez d'abord le répertoire de sortie. Non couvert par les preuves : si l'appel de l'outil MCP convert_to_okf fait la même conversion, et le comportement d'erreur exact en cas d'échec.
Limites d'usage
- Ne pas modifier README*.md directement : ce sont des fichiers générés. Pour changer des entrées, éditez
data/catalog.yamlpuis régénérez ; le texte officiel exige que les entrées passentawesome-okf validateet pytest avant envoi. - Accès réseau/fichiers : la conversion utilise un moteur local (extraction done by local engines only) et ne récupère rien à l'extérieur. Le comportement réseau du meta-server lui-même n'est pas décrit officiellement ; le marquer inconnu.
- Point de confirmation : toute action qui écrit des fichiers (conversion, génération) doit d'abord confirmer le chemin cible. Les outils d'interrogation (search_catalog, list_catalog, get_catalog_entry, catalog_stats) lisent le catalogue, mais les preuves ne suffisent pas à une conclusion de sécurité absolue « n'écrit pas de fichiers et n'exécute pas de commandes » ; cette page ne l'affirme pas.
- Environnement d'exécution : CLI et MCP meta-server implémentés en Python, installés via pipx ; un client compatible MCP est requis. Le texte officiel n'indique pas quels clients MCP sont pris en charge.
- Non confirmé : la plage de langues naturelles prises en charge, les détails d'enregistrement par client MCP et les versions des dépendances système sont absents du texte officiel. Consultez la documentation récente du dépôt avant usage.