Skip to content

Add OSOP session logging rule#219

Open
Archie0125 wants to merge 3 commits intoPatrickJS:mainfrom
Archie0125:add-osop-session-logging
Open

Add OSOP session logging rule#219
Archie0125 wants to merge 3 commits intoPatrickJS:mainfrom
Archie0125:add-osop-session-logging

Conversation

@Archie0125
Copy link
Copy Markdown

@Archie0125 Archie0125 commented Apr 1, 2026

Summary

  • Adds a cursor rule for OSOP session logging — records AI coding sessions as structured .osop + .osoplog.yaml workflow files
  • OSOP (Open Standard for Orchestration Protocol) is a universal workflow protocol that works across all AI coding tools, not just Cursor
  • The rule instructs Cursor to automatically generate session logs after multi-step tasks (debugging, feature implementation, refactoring)

What's included

  • rules/osop-session-logging-cursorrules-prompt-file/.cursorrules — the cursor rule file
  • README entry under Utilities

Links

Summary by CodeRabbit

  • Documentation
    • Added OSOP Session Logging guidelines for recording multi-step AI coding sessions.
    • Instructs generating structured OSOP-format workflow definitions and execution records (YAML) capturing session metadata, node graphs, per-step outputs, tooling, timing, and results.
    • Specifies naming/location conventions for saved session artifacts.
    • Logged sessions can be opened and inspected at osop-editor.vercel.app
    • Applicable to complex tasks, debugging, refactoring, and post-work summaries.

Adds a cursor rule for OSOP (Open Standard for Orchestration Protocol) session
logging, which records AI coding sessions as structured .osop + .osoplog.yaml
workflow files.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 1, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f123f399-a34f-4a40-9bd5-362ef05dbff0

📥 Commits

Reviewing files that changed from the base of the PR and between db3c948 and fd42a6b.

📒 Files selected for processing (2)
  • rules-new/osop-session-logging.mdc
  • rules/osop-session-logging-cursorrules-prompt-file/.cursorrules
✅ Files skipped from review due to trivial changes (2)
  • rules/osop-session-logging-cursorrules-prompt-file/.cursorrules
  • rules-new/osop-session-logging.mdc

📝 Walkthrough

Walkthrough

Added documentation and cursor-rule prompts to record AI coding sessions as OSOP workflow (.osop) and execution log (.osoplog.yaml) artifacts, plus a README link to the new cursor rules and guidance to view logs at the OSOP editor.

Changes

Cohort / File(s) Summary
README update
README.md
Added a Utilities entry for "OSOP Session Logging" linking to cursor rules (rules/osop-session-logging-cursorrules-prompt-file/.cursorrules) and describing OSOP workflow/log outputs and viewer.
OSOP session rule (docs)
rules-new/osop-session-logging.mdc
New MDC rule defining required .osop workflow artifact structure, .osoplog.yaml execution record fields, node type/subtype mapping, storage convention (sessions/ with date-prefixed names), and triggers for when to generate artifacts.
Cursor rules prompt
rules/osop-session-logging-cursorrules-prompt-file/.cursorrules
New prompt instructing assistants to produce .osop and .osoplog.yaml artifacts after multi-step work, including required fields, node mappings, saving conventions, and link to open files in the OSOP editor.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested reviewers

  • PatrickJS

Poem

🐰 In burrows of code where sessions unfold,
I scribble the steps in YAML and gold,
Workflows hop by, each node neatly logged,
Logs open wide — the editor's fogged! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Add OSOP session logging rule' directly and clearly describes the main change: addition of a new Cursor rule for OSOP session logging, which is the primary purpose of this PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

- Update .cursorrules to reference windsurf instead of cursor
- Add rules-new/osop-session-logging.mdc in the newer rule format

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

🧹 Nitpick comments (1)
rules-new/osop-session-logging.mdc (1)

1-5: Consider whether global application is necessary.

This rule uniquely sets alwaysApply: true with an empty globs: field, applying it globally across all files. While most .mdc files target specific file types with glob patterns, a few rules (Gitflow Workflow, Code Quality Guidelines) also use empty globs for cross-cutting concerns.

Since OSOP session logging is triggered by task completion rather than file type, the global scope is a deliberate design choice. However, verify whether this should instead target specific file types where sessions are most valuable (e.g., source code directories) to reduce potential noise in non-code contexts.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@rules-new/osop-session-logging.mdc` around lines 1 - 5, The rule "OSOP
session logging" currently sets alwaysApply: true with an empty globs:, applying
globally; decide whether to keep global scope or restrict it by adding
appropriate glob patterns and/or removing alwaysApply. If you want cross-cutting
behavior, add a brief justification in the rule description that session logging
is triggered by task completion (not file type) and keep alwaysApply: true;
otherwise, remove alwaysApply and populate globs with targeted patterns (e.g.,
source directories or file extensions where session logs are valuable) so the
rule only runs for relevant code artifacts, and update the rule description to
note the change.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@rules-new/osop-session-logging.mdc`:
- Line 58: The runtime metadata currently sets agent: "windsurf" which is
incorrect for Cursor AI; update the runtime agent value (replace the string
"windsurf" with "cursor" in the runtime section where agent: "windsurf" is
defined) so session logs correctly reflect the Cursor agent.
- Line 22: The tags metadata in this rule uses the wrong agent name
("windsurf"); update the tags array on the line containing tags: [windsurf,
<relevant-tags>] to use "cursor" instead of "windsurf" so the tag reads tags:
[cursor, <relevant-tags>]—this ensures the agent name in the rule metadata (the
tags line) is consistent with Cursor AI naming.

In `@rules/osop-session-logging-cursorrules-prompt-file/.cursorrules`:
- Around line 55-58: The runtime metadata currently sets agent: "windsurf" which
mismatches Cursor AI; update the agent field in the .cursorrules runtime block
to "cursor" so session logs correctly reflect the AI editor in use (locate the
agent: "windsurf" entry in the runtime/node_records section and replace it with
agent: "cursor").
- Line 19: The tags line in the .cursorrules file currently includes the agent
name "windsurf" which is inconsistent for a Cursor-specific rule; edit the tags
entry (the line starting with "tags:") to replace "windsurf" with "cursor" (or
add "cursor" and remove "windsurf") so the rule's tags accurately reflect the
Cursor agent.

---

Nitpick comments:
In `@rules-new/osop-session-logging.mdc`:
- Around line 1-5: The rule "OSOP session logging" currently sets alwaysApply:
true with an empty globs:, applying globally; decide whether to keep global
scope or restrict it by adding appropriate glob patterns and/or removing
alwaysApply. If you want cross-cutting behavior, add a brief justification in
the rule description that session logging is triggered by task completion (not
file type) and keep alwaysApply: true; otherwise, remove alwaysApply and
populate globs with targeted patterns (e.g., source directories or file
extensions where session logs are valuable) so the rule only runs for relevant
code artifacts, and update the rule description to note the change.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 55afbff6-ec7a-4ed3-8274-d3cc8100da96

📥 Commits

Reviewing files that changed from the base of the PR and between fc2ce04 and db3c948.

📒 Files selected for processing (3)
  • README.md
  • rules-new/osop-session-logging.mdc
  • rules/osop-session-logging-cursorrules-prompt-file/.cursorrules

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant