How to use
- Copy the installation command and review the source package before installing it in your own agent environment.
- Check the source document for required tools, credentials and supported hosts.
- Describe your input and desired deliverable; review the output against the source material.
npx skills add https://github.com/xsavikx/okf-skills --skill okf-graphqlBefore you start
- Installation does not include a model subscription, API allowance or permission to access your files.
- Repository stars and installation counts describe activity, not an independent quality or security test.
Rendered from the source repository. Headings, examples, code, tables, links, and referenced images are preserved.
GraphQL OKF Connector
This skill provides a Go-based CLI tool to document a GraphQL schema (SDL) as an Open Knowledge Format (OKF) bundle: one concept per user-defined type and per root operation, with fields and operations linked to the types they reference. It needs only the SDL file — no live server.
When to Use
Use this skill when you need to:
- Catalog a GraphQL API from its SDL — types under
types/, queries under
queries/, mutations under mutations/ (subscriptions under subscriptions/).
- Turn the type graph into a connected, browsable view — field→type and
operation→type references edges render as typed edges in okf-viz.
- Round-trip enriched descriptions back to a
.okf-metadata.yamlsidecar.
Setup
go install github.com/xSAVIKx/okf-skills/skills/okf-graphql@latest
# …or: cd skills/okf-graphql && go build -o okf-graphql .How to Use
1. Produce an OKF bundle
./okf-graphql produce --schema <schema.graphql> --out <bundle-dir>--schema(required): path to the GraphQL SDL document.--out(required): output OKF bundle directory.
Each object/input/interface type becomes types/<Name>.md with a # Columns field table (Name | Type | Required); enums emit a # Values list; unions emit their members. Each root field becomes an operation concept with its arguments and return type. Fields/operations link to the types they reference under # Relationships. Re-running preserves enriched descriptions.
2. Ingest / sync descriptions
./okf-graphql ingest --schema <schema.graphql> --bundle <bundle-dir> [--sync]- Verifies each concept still exists in the schema (reports drift); the SDL is never
modified.
--sync: writes the bundle's descriptions to.okf-metadata.yamlnext to the SDL.
3. Inspect the schema (self-description)
./okf-graphql schemaPrints the machine-readable JSON description used by okf-mcp to expose the skill.
