docs: document the SOP hive#318
Merged
Merged
Conversation
Standard Operating Procedures had no documentation page. The only references were a row in the story-tags reference and sop.get / sop.get.mtd appearing in two compliance-agent permission tables. Adds a page under AI Sessions (following the precedent of AI Skills and AI Memory, and because agents are the consumer) covering the record format, limits, the disabled-by-default behavior, how agents discover and load SOPs, permissions, and management via the web UI, CLI, REST API and Python SDK. Also adds SOPs to the Config Hive type list and a SOPs table to the hive section of the permissions reference, which was missing entirely. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JwVp8Ug988F8G7G6tjkMaz
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Standard Operating Procedures (the
sophive) had no documentation page. The only references anywhere indocs/were a row in the story-tags reference andsop.get/sop.get.mtdappearing in two compliance-agent permission tables — nothing describing what an SOP is, its record format, or how to manage one.Changes
docs/9-ai-sessions/sops.md(new) — record format (text/description), the 1 MB limit, the disabled-by-default behavior, how agents discover and load SOPs, permissions, and management via the web UI, CLI, REST API and Python SDK.mkdocs.yml— nav entry under AI Sessions.docs/7-administration/config-hive/index.md— SOPs added to the Hive Types list.docs/8-reference/permissions.md— a### SOPstable; the hive permissions section had no SOP entry at all.Placement
Under AI Sessions rather than Config Hive, following the existing precedent that agent-facing hives live there (AI Skills, AI Memory), and because AI agents are the primary consumer. The Config Hive index links across to it.
Verification
Record schema, validation rules and permission names were read from the hive service source; CLI subcommands and flags from the released
limacharlieCLI source; SDK calls from the Python SDK's hive module; UI location and the/sopsslash command from the web app. Nothing written from memory.markdownlint-cli2— cleanmkdocs build --strict— clean, page renders and appears in the generatedllms.txtscripts/check-list-numbering.py— no new breaks from this pageNote
limacharlie sop listreturns full records includingtext, so the "read names and descriptions first, fetch the body by key" pattern agents follow does not actually avoid the context cost at list time. The page documents this accurately rather than repeating the assumption. Making the list path metadata-only is a separate change outside this repo.🤖 Generated with Claude Code
https://claude.ai/code/session_01JwVp8Ug988F8G7G6tjkMaz