Content
68%Weight 40%Scale 1-5Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
A well-structured navigation-oriented body with concrete commands, exact import/export names, and effective deferral of detail to package-shipped docs. Weakest on workflow clarity — the intended sequence (check installation → scaffold → read bundled docs → use the adapter catalog) is implicit rather than an explicit, verifiable workflow — and it lacks any core-usage code example.
Suggestions
Add an explicit numbered workflow at the top (1. Check if 'chat' is installed by looking for node_modules/chat/docs; 2. Scaffold with 'npx create-chat-sdk' if starting fresh; 3. Read the bundled docs before writing code; 4. Consult the adapter catalog for setup), turning the existing implicit section order into verifiable checkpoints.
Include one minimal copy-paste example of core usage (e.g., creating a Chat instance and handling a Slack message) so the common case is executable without opening the external docs.
Move the inline guides/templates catalog into a separate reference file (e.g., references/resources.md) and keep a one-line pointer in SKILL.md to reduce token cost while preserving discovery.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The body is largely lean — concrete commands ('npx create-chat-sdk --help', 'npm i chat'), pointers to package-shipped docs, and a resource index with one-line summaries rather than explanations of concepts Claude already knows. Falls short of 5 because the ~30-line inline guides/templates catalog duplicates content that ships in 'node_modules/chat/resources/templates.json' (which the body itself says to inspect) and could be trimmed or split out. | 4 / 5 |
Actionability | Concrete, executable guidance throughout: 'npx create-chat-sdk --help', 'npm i chat', exact paths ('node_modules/chat/docs/', 'node_modules/chat/resources/templates.json'), and named importable exports ('ADAPTERS', 'getAdapter', 'isAdapterSlug', 'listEnvVars', 'getSecretEnvVars' from 'chat/adapters'). Not 5 because there is no copy-paste code example of core usage (e.g., instantiating the Chat class or handling a message) — the body defers entirely to external docs. | 4 / 5 |
Workflow Clarity | An implicit sequence exists via section order (scaffold → check installed docs → consult resources → use adapter catalog), and there is one checkpoint ('If those paths do not exist, the chat package is not installed yet. The user can install it with npm i chat'). But no explicit numbered workflow or verification steps, so it matches the anchor of sequence present but checkpoints implicit; not 4 because the steps are never enumerated as a process. | 3 / 5 |
Progressive Disclosure | Good structure: clear sections, and detailed material is appropriately pushed one level deep to package-shipped files ('node_modules/chat/docs/', 'node_modules/chat/resources/guides/*.md', templates.json) and the llms.txt adapter directory rather than inlined. Not 5 because the long inline resource catalog arguably belongs in a separate reference file, and there are no in-bundle reference files organizing this content. | 4 / 5 |
Total | 15 / 20 Passed |