okfy-ai 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 okfy contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,115 @@
+# okfy-ai
+
+Turn docs into agent-readable Open Knowledge Format bundles.
+
+## Install
+
+Run without installing:
+
+```bash
+npx -y okfy-ai demo
+```
+
+Or install globally:
+
+```bash
+npm install -g okfy-ai
+okfy demo
+```
+
+Requires Node.js 20+.
+
+## Quick Start
+
+Convert a docs site into an OKF bundle:
+
+```bash
+npx -y okfy-ai crawl https://docs.stripe.com/checkout --out ./stripe-checkout-okf --max-pages 25
+npx -y okfy-ai validate ./stripe-checkout-okf
+npx -y okfy-ai inspect ./stripe-checkout-okf
+```
+
+Serve it to an MCP client:
+
+```bash
+npx -y okfy-ai serve ./stripe-checkout-okf --mcp
+```
+
+## Local Markdown
+
+```bash
+npx -y okfy-ai import ./docs --out ./docs-okf --source-name "Project docs" --force
+npx -y okfy-ai validate ./docs-okf
+npx -y okfy-ai serve ./docs-okf --mcp
+```
+
+## MCP Config
+
+```json
+{
+  "mcpServers": {
+    "docs-okf": {
+      "command": "npx",
+      "args": ["-y", "okfy-ai", "serve", "./docs-okf", "--mcp"]
+    }
+  }
+}
+```
+
+Ask your agent:
+
+```text
+Use the docs-okf MCP server. Search for the relevant topic, read the best matching concepts, inspect neighbors if needed, and answer with source URLs.
+```
+
+## CLI Commands
+
+```bash
+okfy crawl <url> --out <dir>
+okfy import <path> --out <dir>
+okfy validate <bundle>
+okfy inspect <bundle>
+okfy serve <bundle> --mcp
+okfy demo
+```
+
+## MCP Tools
+
+| Tool | Purpose |
+| --- | --- |
+| `bundle_summary` | Show bundle stats and validation status. |
+| `search_concepts` | Search concept previews by query, type, or tags. |
+| `read_concept` | Read one concept body, frontmatter, links, backlinks, and source. |
+| `get_neighbors` | Traverse outbound links and backlinks around a concept. |
+| `list_types` | List concept types and counts. |
+| `list_tags` | List tags and counts. |
+
+## What okfy Generates
+
+```text
+docs site or Markdown folder
+  -> OKF bundle: Markdown files + YAML frontmatter + links
+  -> MCP server: search_concepts, read_concept, get_neighbors
+  -> source-backed agent answers
+```
+
+Each source page or Markdown file becomes one OKF concept in v0.1. Generated bundles are plain files, so they can be opened, reviewed, diffed, committed, and served locally.
+
+## Security Defaults
+
+- Crawls respect `robots.txt` by default.
+- Crawls stay same-origin by default.
+- Page count, depth, response size, and concurrency are capped.
+- Private network targets are rejected by default for URL crawls.
+- HTML and Markdown are treated as text. Scripts are not executed.
+- MCP tools are read-only in v0.1.
+
+## Links
+
+- GitHub: https://github.com/0dust/OKFy
+- MCP client setup: https://github.com/0dust/OKFy/blob/main/docs/mcp-clients.md
+- OKF: https://github.com/GoogleCloudPlatform/knowledge-catalog/tree/main/okf
+
+## License
+
+MIT.

package/assets/logo.svg

@@ -0,0 +1,14 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="720" height="220" viewBox="0 0 720 220" role="img" aria-labelledby="title desc">
+  <title id="title">okfy</title>
+  <desc id="desc">okfy wordmark with linked knowledge nodes</desc>
+  <rect width="720" height="220" rx="28" fill="#f7f5ef"/>
+  <g transform="translate(54 44)">
+    <path d="M34 28h74c22 0 40 18 40 40v20c0 22-18 40-40 40H34C12 128-6 110-6 88V68c0-22 18-40 40-40Z" fill="#20342d"/>
+    <circle cx="36" cy="78" r="18" fill="#d6f36a"/>
+    <circle cx="106" cy="58" r="12" fill="#f7f5ef"/>
+    <circle cx="108" cy="100" r="12" fill="#f7f5ef"/>
+    <path d="M52 73 94 61M53 84l43 13" stroke="#d6f36a" stroke-width="9" stroke-linecap="round"/>
+    <path d="M190 124V31h32v36h10l26-36h37l-35 46 38 47h-39l-28-36h-9v36h-32Zm123 0V31h77v27h-45v15h39v26h-39v25h-32Zm95 0 34-52-32-41h38l15 21 15-21h36l-33 43 38 50h-39l-19-26-18 26h-35Zm127 0V92l-36-61h37l16 32 17-32h35l-37 61v32h-32Z" fill="#20342d"/>
+  </g>
+  <text x="360" y="184" text-anchor="middle" font-family="ui-monospace, SFMono-Regular, Menlo, Consolas, monospace" font-size="20" letter-spacing="1.5" fill="#5f5a4f">OPEN KNOWLEDGE FORMAT FOR AGENTS</text>
+</svg>