Install
pipx install awesome-okfPara quem
- Programadores ou utilizadores de agent que queiram que um AI agent consulte diretamente o catálogo de recursos OKF (Open Knowledge Format): o catálogo inclui ferramentas, plugins, skills, propostas e documentos relacionados com OKF.
- Quem já usa um cliente compatível com MCP e quer pesquisa programática com ferramentas como
search_catalogeget_catalog_entry. - Quem quer transformar o próprio conteúdo num catálogo OKF (ficheiros Markdown + YAML frontmatter) e verificá-lo com
myokf validate.
Quando não encaixa:
- Situações em que não precisa de descoberta ou conversão de recursos OKF e só quer consultar dados de outros domínios.
- Editores diretos do README — o texto oficial diz que README*.md é gerado, não deve ser alterado à mão, e é preciso mudar
data/catalog.yamle voltar a gerar. - Pontos que o texto oficial não explica (lista de clientes suportados, intervalo de línguas de entrada da conversão, requisitos concretos do sistema) não são adivinhados nesta página; ficam marcados como não confirmados.
Primeira tentativa em 3 minutos
Pré-requisito: ambiente Python local com pipx instalado (método oficial de instalação). É uma CLI + MCP meta-server implementada em Python.
-
Instalar: executar no terminal
pipx install awesome-okf -
Ligar o agent: registe o MCP server no seu cliente MCP com o comando
awesome-okf-server(a nota oficial é "Connect it to your MCP client"; os caminhos exatos de registo por cliente não estão na evidência, siga a documentação do seu cliente). -
Disparar uma tarefa só de leitura de baixo risco: diga ao agent «usa search_catalog para pesquisar ferramentas OKF no catálogo e devolve as primeiras entradas». A ferramenta aceita query/kind/limit, consulta o catálogo e não escreve.
Sinal de sucesso: o agent devolve entradas do catálogo (com base em get_catalog_entry / list_catalog) ou totais de catalog_stats — o meta-server está ligado.
Nota: a primeira tentativa deve só consultar. convert_to_okf e scripts/convert-to-okf.py criam ficheiros de catálogo OKF e escrevem em disco. Execute-os só depois de confirmar o caminho de destino e de saber que geram ficheiros Markdown + YAML frontmatter.
Casos de uso
Caso 1: pedir ao agent para encontrar recursos OKF. Cenário: quer saber que ferramentas ou competências existem no ecossistema OKF. Peça ao agent ligado: «usa search_catalog, põe as palavras-chave em query, filtra por kind se quiser e controla o número com limit». O agent chama a ferramenta de pesquisa do meta-server e devolve ferramentas/plugins/skills/propostas/documentos correspondentes; para totais use catalog_stats. É só consulta; o resultado são as próprias entradas do catálogo.
Caso 2: transformar conteúdo existente num catálogo OKF. Cenário: tem texto estruturado (listas, JSON, pares chave-valor, listas de URL) e quer um formato de conhecimento amigável a um agent. Use scripts/convert-to-okf.py; o modo --format anything tenta a cadeia de análise (list → JSON → key-value → URLs → line-per-row) até um analisador ter sucesso. Resultado confirmável: um catálogo de ficheiros Markdown com YAML frontmatter, depois verificável com myokf validate. Efeito secundário: este passo escreve ficheiros em disco; a conversão é feita por um motor local. Confirme primeiro o diretório de saída. A evidência não cobre: se chamar a ferramenta MCP convert_to_okf faz a mesma conversão, e o comportamento exato de erro quando falha.
Limites de uso
- Não edite README*.md diretamente: são gerados. Para alterar entradas, edite
data/catalog.yamle volte a gerar; o texto oficial exige que as entradas passemawesome-okf validatee pytest antes de as enviar. - Acesso de rede/ficheiros: a conversão usa um motor local (extraction done by local engines only) e não obtém nada do exterior. O comportamento de rede do próprio meta-server não está descrito oficialmente; marque como desconhecido.
- Ponto a confirmar: qualquer ação que escreva ficheiros (conversão, geração) deve confirmar primeiro o caminho de destino. As ferramentas de consulta (search_catalog, list_catalog, get_catalog_entry, catalog_stats) leem o catálogo, mas a evidência não chega para a conclusão absoluta de segurança «não escreve ficheiros nem executa comandos»; esta página não o afirma.
- Ambiente de execução: CLI e MCP meta-server implementados em Python e instalados via pipx; é preciso um cliente compatível com MCP. O texto oficial não indica quais clientes MCP são suportados.
- Não confirmado: o intervalo de línguas naturais suportadas, os detalhes de registo de cada cliente MCP e as versões das dependências de sistema não estão no texto oficial. Consulte a documentação recente do repositório antes de usar.