Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ jobs:
platforms: false
checks: |
pnpm smoke:node
pnpm check:agent-docs

installed-platforms:
needs: ci
Expand Down
9 changes: 9 additions & 0 deletions changes/docs-skill-cut.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
### Changed — may break callers

- **The agent skill is shorter.** `SKILL.md` keeps what an agent needs on every turn (the profile rule, answering
from stored meetings, the limits on changes, output) in about 8 KB instead of 20 KB, and links the rest in
`skills/zoom-cli/references/`: search, people and projects, preparation, the archive, meetings in Zoom and setup.
No rule was dropped. Names gone in 0.77.0 are corrected: `meetings link --event-id`, and
`meetings create|update|cancel|invitation` instead of `remote-meetings`, and what `--dry-run` shows. The skill
now tells agents that `meetings show` and `meetings list` ask Zoom by default and that `--offline` reads only the
store. An agent that reads the skill pays about 3,000 fewer tokens on every turn.
10 changes: 10 additions & 0 deletions docs/dev/BACKLOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,16 @@ an item here names it when zm only adopts it.
- **Claim before code:** put `🚧 <branch>` on the line in the first push of the branch.
- **Close in the PR that ships the work:** delete the line here in that PR.

## Now (P1)

- **ZM-30** · P1 · ops · **Do not release before this:** build on the cli-base that installs a skill's
`references/` (`skill install`, `skill show <part>`; WC-DOC-22, cli-base 0.106.0 or later) and the cli-core that
serves them over MCP (`skillResources`; cli-core 0.678.0 still serves only SKILL.md). The skill now links
`skills/zoom-cli/references/*.md`; with cli-base 0.102.1 `zm skill install` copies only SKILL.md and
`zm skill show search` fails. zm builds its own skill command (`src/agent-skill.ts`) and MCP skill (`src/run.ts`)
from the SKILL.md URL alone, so after the bump check all three: install into a temporary HOME and list the folder,
`zm skill show search`, and the MCP resource list.

## Next (P2)

- **ZM-5** · P2 · 🚧 `feat/saved-meeting-searches` · Saved searches: `zm <profile> searches create/run/list/show/delete`,
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@
"security:no-leak": "cli-testing security no-leak . contracts/no-leak.json",
"version:check": "cli-dev version",
"version:sync": "cli-dev version --sync",
"package:check": "node scripts/package-check.ts"
"package:check": "node scripts/package-check.ts",
"check:agent-docs": "node --experimental-strip-types scripts/check-agent-docs.ts"
},
"dependencies": {
"@wirecat/cli-base": "0.102.1",
Expand Down
28 changes: 28 additions & 0 deletions scripts/check-agent-docs.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import assert from "node:assert/strict"
import { readdirSync, readFileSync } from "node:fs"
import { withVersion } from "@wirecat/cli-base/skill"
import { validateSkill } from "@wirecat/cli-core/skill-validation"
import { VERSION } from "../dist/version.js"
import { createProgram } from "./command-program.ts"

// An agent carries SKILL.md in every turn of its session, so the core stays near 2,000 tokens (WC-DOC-22).
const MAX_SKILL_BYTES = 8_500

const file = new URL("../skills/zoom-cli/SKILL.md", import.meta.url)
const source = readFileSync(file, "utf8")
const program = createProgram()
assert.deepEqual(validateSkill(source, { folder: "zoom-cli", file: file.pathname, program }), [])
assert.deepEqual(validateSkill(withVersion(source, VERSION), { folder: "zoom-cli", version: VERSION, program }), [])
const size = Buffer.byteLength(source)
assert.ok(size <= MAX_SKILL_BYTES, `SKILL.md is ${size} bytes; move detail to references/ (at most ${MAX_SKILL_BYTES})`)

// validateSkill reads links and command paths only after frontmatter, so each reference borrows SKILL.md's.
const frontmatter = /^---\r?\n[\s\S]*?\r?\n---\r?\n/.exec(source)?.[0] ?? ""
const references = new URL("../skills/zoom-cli/references/", import.meta.url)
for (const name of readdirSync(references).filter((entry) => entry.endsWith(".md"))) {
const reference = new URL(name, references)
const text = frontmatter + readFileSync(reference, "utf8")
assert.deepEqual(validateSkill(text, { file: reference.pathname, program }), [], `references/${name}`)
assert.ok(source.includes(`](references/${name})`), `SKILL.md does not link references/${name}`)
}
process.stdout.write("skill, version and references: ok\n")
4 changes: 2 additions & 2 deletions scripts/package-check.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ const PACKED = [
"LICENSE",
"constants.json",
"contracts/wirecat.json",
"skills/zoom-cli/SKILL.md",
"skills/zoom-cli/",
"scenarios/",
]
const PACKED_SAID =
"dist/, package.json, README.md, LICENSE, constants.json, contracts/wirecat.json, the agent skill and the guide scenarios"
"dist/, package.json, README.md, LICENSE, constants.json, contracts/wirecat.json, the agent skill with its references and the guide scenarios"

const failed = releaseCheck([{ name: "package contents", run: packContents(root, PACKED, PACKED_SAID) }], {
version: packageVersion(root),
Expand Down
Loading
Loading