Exported functions in state/lib/docs.ts. .md file to compare - side-by-side diff against docs
docs
description: "Triggers on prompt mention of 'docs'."
What it does for you
Connects your assistant to your Notion pages and docs.
What it produces
A recent result, so you can see the kind of work it returns.
loading…
How to get it
These run inside the Snappy workspace. Want this working in your business? I set skills like this up with you, in one focused week.
For developers how this skill is built, graded, and how it runs
at a glance- the short version
what's inside - the parts that make up a skill 3/4 present
A skill is just a few plain-text files. Only the main one is required. The rest are optional, added as the work needs them. This is what the skill is made of; how it runs is just below.
state/skills/docs/SKILL.md
present
state/lib/docs.ts
present
state/bin/docs/
not present
state/skills/docs/AGENTS.md
present
how it's graded - what counts as a good run 4 criteria · 3 deterministic · 1 judge
Each row is one thing a good run has to get right. deterministic means a quick check decides, pass or fail. judge means the AI reads the result and rates it. Grading each piece on its own (instead of one overall score) shows exactly where a run fell short, so the fix is obvious.
how it runs - the shared frame every skill uses 5/5 present
Every skill runs the same way. One part does the work, a separate part checks it, and a short loader hands the AI exactly what it needs for the job. Anything this skill doesn't use shows a one-line note saying why, on purpose, not by accident.
state/log/pending-eval.ndjson what it has learned - fixes written back in over time sample
When a run hits something this skill didn't handle, the fix gets written back into the skill so it doesn't happen again. FIXED means it was corrected on the spot. LOGGED means it's queued for a bigger rewrite. Either way, the skill gets a little better and never makes the same mistake twice.
- Loading feedback rows…
how the work flows- who makes it, who checks it
import from `state/lib/docs.ts` — `search()`, `getPage()`, `createPage()`, `getBlockChildren()`, `appendBlocks()`, `queryDatabase()
search()` or `queryDatabase()` first to confirm target before writes
SKILL.md- the skill, written out in plain English
docs
Notion REST API operations for all snappy-* skills.
Ported from kernel snappy-docs in Phase 0.5. See state/lib/docs.ts for the full API surface.
Steps
search()- seestate/lib/docs.tsgetPage()- seestate/lib/docs.tscreatePage()- seestate/lib/docs.tsgetBlockChildren()- seestate/lib/docs.tsappendBlocks()- seestate/lib/docs.tsqueryDatabase()- seestate/lib/docs.ts
Eval
Actor: the exported functions in state/lib/docs.ts. Auditor: none wired yet - eval is manual (Robert review). File a state/log/pending-eval.ndjson row on each run.
Score convention:
| Outcome | Score |
|---|---|
| Pass on first try | 1.0 |
| Failed first, auto-fix applied, re-check passed | 0.5 |
| Still failing or unrecoverable | 0.0 |
Gotchas
via the Phase 0.5 driver. Only these rewrites were applied: already in state/lib/)
realpathSync(process.argv[1])CLI guard wrapped in try/catch
- See the kernel SKILL.md for the original long-form guidance if you need it
(read-only reference at the kernel path above).
Graduation
This skill is prose. Graduate by defining a deterministic auditor and flipping eval: auto.
Rubric
criteria:
- name: uses_valid_skill_inputs
kind: deterministic
check: "The skill execution uses one of the inputs specified in SKILL.md: search_input, getPage_input, createPage_input, getBlockChildren_input, or appendBlocks_input."
- name: calls_docs_ts_function
kind: deterministic
check: "The skill execution logs indicate a call to a function exported by `state/lib/docs.ts`."
- name: logs_pending_eval_row
kind: deterministic
check: "A new row is appended to `state/log/pending-eval.ndjson` after the skill executes."
- name: notion_api_response_valid
kind: judge
check: "The output of the Notion API call, if any, is a well-formed JSON object and represents a successful operation."AGENTS.md- what the AI loads when this skill comes up
docs - loader
Per-turn rules for the docs skill. Full reference: state/skills/docs/SKILL.md. Do not skip these.
Critical Rules
_(no failures recorded yet - this skill is a Phase 0.5 prose port from kernel snappy-docs. No hard-won rules have surfaced yet. Read state/skills/docs/SKILL.md and state/lib/docs.ts before invoking.)_
Commands
| ui dashboard | state/skills/docs/resources/ui.openui | |invoke: import from state/lib/docs.ts - search(), getPage(), createPage(), getBlockChildren(), appendBlocks(), queryDatabase() |verify: search() or queryDatabase() first to confirm target before writes |eval log: state/log/pending-eval.ndjson (manual eval - skill: "docs")
OpenUI Resource
- Skill-owned OpenUI Lang resource:
state/skills/docs/resources/ui.openui. Read it before rendering or editing this skill's generated component surface. - Treat this resource as a first-class artifact of the skill, not a generic chat response. Improve it when the skill's user-facing output needs to become richer.
- System resources compose OpenUI primitives and inherit SnappyChat tokens. Use
ui_contract: brandedin SKILL.md only for deliberate platform or client visuals.
Known Pitfalls
- Notion blocks API is paginated -
getBlockChildrenmay need multiple calls; don't assume one fetch is the whole page createPageandappendBlocksare write side-effects - keep behind scope-only default
Self-Test
An agent reading this should correctly:
- [ ] Use
state/lib/docs.ts, not rawfetchagainst api.notion.com - [ ] Paginate
getBlockChildrenfor long pages - [ ] Default writes to scope-only
Self-report
If this loader fell short, append a line:
echo "[$(date -u +%FT%TZ)] docs: <what was missing>" >> state/log/loader-feedback.log
<!-- kernel-ok: historical attribution for the PID-loader pattern. -->
Self-correcting loader (PID feedback)
This is the rule that makes loaders learn. Ported from snappy-kernel, where it demonstrably worked: the snappy-dom-cartographer skill mapped Skool admin UI once, every later ship-agent inherited the full map for free.
Before you finish, do two things:
1. Fix gaps (P - proportional). MANDATORY. If this loader didn't cover your case - if you had to read another file, run an undocumented command, work around a wrong selector, or discover a quirk - you MUST attempt an Edit to this AGENTS.md before you log.
- Default action: edit this file. Surgical. Add the missing line, table
row, or code example where it belongs. No restructuring.
- Only
LOGGEDis allowed when: the fix needs >10 lines, spans multiple
files, or requires a structural rewrite. In that case the state/regen/drain.sh queue picks it up asynchronously.
- "I didn't have time" / "it's minor" / "the next agent will figure it out"
are NOT valid reasons. Minor gaps compound - that's the whole point of this loop.
- Concrete example of a valid P-fix: discover
agent-browser screenshot
takes path positionally not as --output <path>. One line in a table. Edit it in. Do not just log it.
- The goal: the next agent never has to leave the loader.
2. Log the result.
echo "[$(date -u +%FT%TZ)] docs: <what was missing or fixed> [FIXED|LOGGED]" >> state/log/loader-feedback.log
FIXED= you patched this loader inline (P-fix).LOGGED= too large for inline; the PostToolUse enqueue + Stop-hook drain
will rewrite the loader from scratch on next session-end.
Do not skip this. Every agent run must leave the system better than it found it. The loader is the setpoint; you are the sensor; the gap is the error signal; closing the gap is the correction.
api.ts- the code it can call
#!/usr/bin/env npx tsx
/**
* snappy-docs/api.ts -- Notion REST API operations for all snappy-* skills.
*
* Uses NOTION_TOKEN from snappy-settings/.env.cache.
* Direct Notion API calls at api.notion.com/v1.
*
* Usage:
* npx tsx api.ts search "meeting notes"
* npx tsx api.ts page <page_id>
* npx tsx api.ts children <block_id>
* npx tsx api.ts query <database_id>
*
* Or import as module:
* import { search, getPage, createPage } from "./docs.ts";
*/
import { env } from "./env.ts";
import { realpathSync } from "fs";
const NOTION_API = "https://api.notion.com/v1";
async function notion(path: string, method = "GET", body?: Record<string, unknown>) {
const res = await fetch(`${NOTION_API}${path}`, {
method,
headers: {
Authorization: `Bearer ${env("NOTION_TOKEN")}`,
"Notion-Version": "2022-06-28",
"Content-Type": "application/json",
},
body: body ? JSON.stringify(body) : undefined,
});
const data = await res.json();
if (data.object === "error") {
throw new Error(`Notion ${method} ${path} failed: ${data.message}`);
}
return data;
}
// --- Public API ---
export async function search(query: string, pageSize = 10) {
return notion("/search", "POST", { query, page_size: pageSize });
}
export async function getPage(pageId: string) {
return notion(`/pages/${pageId}`);
}
export async function createPage(
parentId: string,
title: string,
children?: Record<string, unknown>[]
) {
const body: Record<string, unknown> = {
parent: { page_id: parentId },
properties: {
title: { title: [{ text: { content: title } }] },
},
};
if (children?.length) body.children = children;
return notion("/pages", "POST", body);
}
export async function getBlockChildren(blockId: string) {
return notion(`/blocks/${blockId}/children?page_size=100`);
}
export async function appendBlocks(blockId: string, children: Record<string, unknown>[]) {
return notion(`/blocks/${blockId}/children`, "PATCH", { children });
}
export async function queryDatabase(databaseId: string, filter?: Record<string, unknown>) {
const body: Record<string, unknown> = {};
if (filter) body.filter = filter;
return notion(`/databases/${databaseId}/query`, "POST", body);
}
// --- CLI ---
if ((() => { try { return import.meta.url === `file://${realpathSync(process.argv[1])}`; } catch { return false; } })()) {
(async () => {
const [, , cmd, ...args] = process.argv;
switch (cmd) {
case "search": {
const query = args.join(" ");
if (!query) { console.error("Usage: api.ts search <query>"); process.exit(1); }
const data = await search(query);
for (const r of data.results) {
const title = r.properties?.title?.title?.[0]?.plain_text
|| r.properties?.Name?.title?.[0]?.plain_text
|| "(untitled)";
console.log(`${r.id}\t${r.object}\t${title}`);
}
break;
}
case "page": {
const [pageId] = args;
if (!pageId) { console.error("Usage: api.ts page <page_id>"); process.exit(1); }
const data = await getPage(pageId);
console.log(JSON.stringify(data, null, 2));
break;
}
case "children": {
const [blockId] = args;
if (!blockId) { console.error("Usage: api.ts children <block_id>"); process.exit(1); }
const data = await getBlockChildren(blockId);
for (const b of data.results) {
const text = b[b.type]?.rich_text?.[0]?.plain_text || "";
console.log(`${b.id}\t${b.type}\t${text.slice(0, 80)}`);
}
break;
}
case "query": {
const [dbId] = args;
if (!dbId) { console.error("Usage: api.ts query <database_id>"); process.exit(1); }
const data = await queryDatabase(dbId);
console.log(`${data.results.length} rows`);
for (const r of data.results) {
const title = r.properties?.Name?.title?.[0]?.plain_text
|| r.properties?.title?.title?.[0]?.plain_text
|| "(untitled)";
console.log(`${r.id}\t${title}`);
}
break;
}
default:
console.log("Usage: npx tsx api.ts [search|page|children|query] ...");
}
})();
}
scripts- helper scripts it can run
prose-only skill - 1 inline code block live in SKILL.md above (no state/bin/ sidecar yet).
how we check it- the checks, plus the last 10 runs
| timestamp | verb | score | primary_issue | artifact |
|---|---|---|---|---|
| 2026-04-25 04:11Z | - | 1.00 | - | - |
| 2026-04-21 15:59Z | - | 1.00 | - | - |
| 2026-04-21 15:56Z | - | 1.00 | - | - |
| 2026-04-21 03:53Z | - | 1.00 | - | - |
| 2026-04-25 04:11Z | - | 1.00 | - | - |
| 2026-04-21 15:59Z | - | 1.00 | - | - |
| 2026-04-21 15:56Z | - | 1.00 | - | - |
| 2026-04-21 03:53Z | - | 1.00 | - | - |
| 2026-04-25 04:11Z | - | 1.00 | - | - |
| 2026-04-21 15:59Z | - | 1.00 | - | - |