agentleFS
mrcbrbn5361mrcbrbn5361/SyncytiumMD/.cursor/rules/adapter-standards.mdc

SyncytiumMD / rules

Cursor rule6 starsChanged 7 days agoMITView on GitHub

Standards for implementing new IDE and CLI bridge adapters in SyncytiumMD

The file

We split this adapter-standards.mdc into the rules it gives an agent

5 rules. About 0 are common, 0 are distinctive, and 5 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 5

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Do not edit manually unless you plan to run reverse-sync.

    line 8
  2. Very specific:

    When adding or updating adapters in src/adapters/:

    line 14
  3. Very specific:

    Every adapter must implement AgentAdapter from src/core/types.ts.

    line 16
  4. Very specific:

    Every file must include a leading or trailing SyncytiumMD header comment (e.g.

    line 20
  5. Very specific:

    Add unit tests verifying target file generation in tests/syncytium.test.ts.

    line 26

≈ “Common” is an estimate: at least 1 in 5 of the 6,668 Cursor rule files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
adapter-standards.mdc
---
description: Standards for implementing new IDE and CLI bridge adapters in SyncytiumMD
alwaysApply: true
---
<!--
  ⚠️ AUTO-GENERATED BY SYNCYTIUM-MD ⚠️
  This file is automatically synchronized from .syncytium/
  Do not edit manually unless you plan to run reverse-sync.
  Source of truth: .syncytium/
-->

# AI Tool Adapter Guidelines

When adding or updating adapters in `src/adapters/`:
1. **Interface Contract:**
   - Every adapter must implement `AgentAdapter` from `src/core/types.ts`.
   - Implement `readonly id`, `readonly name`, `readonly category`, `readonly description`, `readonly defaultTargetFiles`.
2. **Deterministic Output:**
   - The `generate(context: CanonicalContext)` method must return an array of `GeneratedFile[]`.
   - Every file must include a leading or trailing SyncytiumMD header comment (e.g. `# Auto-generated by SyncytiumMD`) unless the format forbids comments.
3. **Preserve User Modifications:**
   - Adapters should respect user custom sections where supported.
4. **Registration:**
   - Register all new adapters in `AdapterRegistry` (`src/adapters/registry.ts`).
5. **Coverage:**
   - Add unit tests verifying target file generation in `tests/syncytium.test.ts`.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.