agentleFS
Sign inStart free
VuDZVuDZ/RoslynMcpServer/.cursor/rules/roslyn-mcp-docs-agents.mdc

RoslynMcpServer / rules

Cursor rule8 starsChanged 45 days agoMITView on GitHub

Docs sync AGENTS/README, agent conventions, PowerShell, secrets

The file

We split this roslyn-mcp-docs-agents.mdc into the rules it gives an agent

2 rules. About 0 are common, 1 is distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    When adding/changing MCP tools, Descriptions, or agent-visible behavior, update together:

    line 20
  2. Very specific:

    After MCP rebuild: get_mcp_server_info expect current version (1.3.32+.

    line 32

≈ “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
roslyn-mcp-docs-agents.mdc
---
description: Docs sync AGENTS/README, agent conventions, PowerShell, secrets
alwaysApply: true
---

# Docs & agent conventions

## Layers

| Layer | Role |
|-------|------|
| MCP tool `[Description]` | Per-tool API: params, caps, anti-patterns |
| `AGENTS.md.sample` | Session policy only (when / MCP vs host / bans) — copy to app repos as `AGENTS.md` |
| `CHANGELOG.md` | Human changelog of agent-visible tools and behavior |
| README **Reference: MCP Tools** | Tool catalog |
| README Agent Initialization | Short pointer to sample — **not** a full copy of AGENTS |

## Keep in sync (when tools change)

When adding/changing MCP tools, Descriptions, or agent-visible behavior, update **together**:

1. **`AGENTS.md.sample`** — only if session policy changes (init, bans, hybrid search, edit/secrets). Do **not** paste tool params/caps into AGENTS.
2. **`CHANGELOG.md`** — semver row when agent-visible behavior changes. **`README.md`** — **Reference: MCP Tools** (EN; RU Reference as needed) when the public tool surface changes. The README keeps a link to the changelog.
3. **Version** in `RoslynMcpServer.csproj` when shipping tool changes (see `roslyn-mcp-version-bump.mdc`).

Copy `AGENTS.md.sample` → app repo `AGENTS.md` — **no machine-specific paths**.

## Agent workflow (summary)

- Quick read-only: `load_workspace` → symbol tools / Grep.
- Edit/build/test/run: full init → MCP `dotnet_*` only (no shell `dotnet build/test`).
- After MCP rebuild: `get_mcp_server_info` expect current version (1.3.32+; source of truth — `RoslynMcpServer.csproj`).
- Windows PowerShell 5.x: use `;` between commands, not `&&`.
- Secrets: never PAT/passwords in chat/commits; env / user-secrets; report configured yes/no only.
- IDE edits: host edit/write; headless: MCP `apply_patch` / AST tools.
- Rename: `previewOnly=true` first.

## App repos should document

Executable `.csproj` for `run_dotnet_run`, sample args, `global.json` pin, integration notes (TFS vs Azure) in README or `.cursor/rules` — not in portable AGENTS alone.

## Spec archive

Epoch plans and review packages: see `roslyn-mcp-docs-lifecycle.mdc` (start-of-work junk check; remind to archive when the series is closed).

## Engineering style (this repo)

Base Truth: minimal diffs; no wholesale rewrites. Async I/O; no `.Result`/`.Wait()`. Null-check references. Tests: xUnit (+ Moq when mocking). Prefer Options/`IOptions` for config if adding settings.

English for text that lives in code: comments, XML docs, log/diagnostic messages, exception messages, test failure text and asserted fragments. Localized external output kept as test data stays verbatim. Canon: `docs/code-style.md`, §Language. Project docs (`docs/`, README, AGENTS, these rules) keep their current language.

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.

Check your setup, free