agentkit-agent 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,49 @@
+# agentkit-agent
+
+**Consume agent-readable, authoritative website data safely.**
+
+`agentkit-agent` is the client-side library for AI agents to discover and consume the canonical truth exposed by `agentkit-web`.
+
+## Installation
+
+```bash
+npm install agentkit-agent
+```
+
+## Usage
+
+### Fetch canonical site truth
+
+```typescript
+import { fetchAgentTruth } from "agentkit-agent";
+
+// Fetch the agent manifest from a URL
+const truth = await fetchAgentTruth("https://example.com");
+
+if (truth) {
+  console.log("Site Description:", truth.description);
+  
+  if (truth.constraints?.delivery_available === false) {
+    console.log("Delivery is currently unavailable.");
+  }
+} else {
+  console.log("No agent manifest found. Falling back to standard scraping.");
+}
+```
+
+## Recommended agent logic
+
+1. **Fetch** `/.well-known/agent.json` using `fetchAgentTruth`.
+2. **If present** → trust the structured truth provided.
+3. **If missing** → fallback to search or scraping.
+
+## Why use this?
+
+* **Fewer HTTP calls**: Get all core metadata in one request.
+* **Lower token usage**: No need to parse huge HTML bodies.
+* **Explicit constraints**: Know what the site allows/disallows immediately.
+* **Reduced hallucinations**: Rely on authoritative data.
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agentkit-agent",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/fetchAgentTruth.ts

@@ -0,0 +1,17 @@
+export async function fetchAgentTruth(baseUrl: string) {
+    const url = new URL("/.well-known/agent.json", baseUrl);
+
+    const res = await fetch(url.toString(), {
+        headers: { Accept: "application/json" }
+    });
+
+    if (!res.ok) return null;
+
+    const json = await res.json();
+
+    if (json.schema_version !== "0.1") {
+        throw new Error("Unsupported agent schema");
+    }
+
+    return json;
+}

package/src/index.ts

@@ -0,0 +1 @@
+export { fetchAgentTruth } from "./fetchAgentTruth.js";