Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/copilot-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ row: "- [{summary}](../{filename})"
- [Config layers deep-merge rule by rule: defaults, convention, kinds, then overrides. `--explain` and `mdsmith kinds resolve` show which layer set each effective value, per leaf.](../docs/features/config-transparency.md)
- [Built-in rules flag broken links and missing anchors, enforce per-file section schemas, and keep Markdown in the right folders. Schemas can be inline on a file kind or shared via `proto.md` files.](../docs/features/cross-file-integrity.md)
- [`mdsmith deps` lists what a file pulls in — includes, catalogs, build inputs, and links — or, with `--incoming`, every file that points at it. The LSP call-hierarchy walks the same graph in your editor.](../docs/features/dependency-graph.md)
- [A bundled VS Code extension and Claude Code plugins drive the same `mdsmith lsp` server, so diagnostics, fix-on-save, and navigation reach your editor and your coding agent unchanged.](../docs/features/editor-agent-integration.md)
- [A VS Code extension and Claude Code plugins run the same rule engine, so diagnostics, quick-fixes, and navigation reach your editor and your agent.](../docs/features/editor-agent-integration.md)
- [Tag each file with a `kind`, then validate its headings and front matter against a schema declared inline on the kind or shared via a `proto.md` template — so a whole directory obeys one contract.](../docs/features/file-kinds-schemas.md)
- [A Git merge driver auto-resolves conflicts inside generated blocks, and a pre-merge-commit hook re-runs `mdsmith fix` and re-stages the result, so generated content never blocks a merge.](../docs/features/git-native.md)
- [The mdsmith feature overview shared by the repository README and the website. Each capability links to a fuller page with rules and examples.](../docs/features/index.md)
Expand Down
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ row: "- [{summary}]({filename})"
- [Config layers deep-merge rule by rule: defaults, convention, kinds, then overrides. `--explain` and `mdsmith kinds resolve` show which layer set each effective value, per leaf.](docs/features/config-transparency.md)
- [Built-in rules flag broken links and missing anchors, enforce per-file section schemas, and keep Markdown in the right folders. Schemas can be inline on a file kind or shared via `proto.md` files.](docs/features/cross-file-integrity.md)
- [`mdsmith deps` lists what a file pulls in — includes, catalogs, build inputs, and links — or, with `--incoming`, every file that points at it. The LSP call-hierarchy walks the same graph in your editor.](docs/features/dependency-graph.md)
- [A bundled VS Code extension and Claude Code plugins drive the same `mdsmith lsp` server, so diagnostics, fix-on-save, and navigation reach your editor and your coding agent unchanged.](docs/features/editor-agent-integration.md)
- [A VS Code extension and Claude Code plugins run the same rule engine, so diagnostics, quick-fixes, and navigation reach your editor and your agent.](docs/features/editor-agent-integration.md)
- [Tag each file with a `kind`, then validate its headings and front matter against a schema declared inline on the kind or shared via a `proto.md` template — so a whole directory obeys one contract.](docs/features/file-kinds-schemas.md)
- [A Git merge driver auto-resolves conflicts inside generated blocks, and a pre-merge-commit hook re-runs `mdsmith fix` and re-stages the result, so generated content never blocks a merge.](docs/features/git-native.md)
- [The mdsmith feature overview shared by the repository README and the website. Each capability links to a fuller page with rules and examples.](docs/features/index.md)
Expand Down
2 changes: 1 addition & 1 deletion CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ row: "- [{summary}]({filename})"
- [Config layers deep-merge rule by rule: defaults, convention, kinds, then overrides. `--explain` and `mdsmith kinds resolve` show which layer set each effective value, per leaf.](docs/features/config-transparency.md)
- [Built-in rules flag broken links and missing anchors, enforce per-file section schemas, and keep Markdown in the right folders. Schemas can be inline on a file kind or shared via `proto.md` files.](docs/features/cross-file-integrity.md)
- [`mdsmith deps` lists what a file pulls in — includes, catalogs, build inputs, and links — or, with `--incoming`, every file that points at it. The LSP call-hierarchy walks the same graph in your editor.](docs/features/dependency-graph.md)
- [A bundled VS Code extension and Claude Code plugins drive the same `mdsmith lsp` server, so diagnostics, fix-on-save, and navigation reach your editor and your coding agent unchanged.](docs/features/editor-agent-integration.md)
- [A VS Code extension and Claude Code plugins run the same rule engine, so diagnostics, quick-fixes, and navigation reach your editor and your agent.](docs/features/editor-agent-integration.md)
- [Tag each file with a `kind`, then validate its headings and front matter against a schema declared inline on the kind or shared via a `proto.md` template — so a whole directory obeys one contract.](docs/features/file-kinds-schemas.md)
- [A Git merge driver auto-resolves conflicts inside generated blocks, and a pre-merge-commit hook re-runs `mdsmith fix` and re-stages the result, so generated content never blocks a merge.](docs/features/git-native.md)
- [The mdsmith feature overview shared by the repository README and the website. Each capability links to a fuller page with rules and examples.](docs/features/index.md)
Expand Down
61 changes: 44 additions & 17 deletions docs/features/editor-agent-integration.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
---
title: "Editors and agents"
summary: >-
A bundled VS Code extension and Claude Code plugins drive the same
`mdsmith lsp` server, so diagnostics, fix-on-save, and navigation
reach your editor and your coding agent unchanged.
A VS Code extension and Claude Code plugins run the same rule
engine, so diagnostics, quick-fixes, and navigation reach your
editor and your agent.
icon: plug
link: "/guides/editors/vscode/"
weight: 4
group: "One engine, every surface"
---
# Editors and agents

The rule engine is the same everywhere. The value is getting it
into the tools you already use without a separate config.
mdsmith runs one rule engine everywhere. The check that gates a
merge in CI is the same one your editor shows you. Your coding
agent sees that same check as it edits your Markdown. No second
config, no second ruleset.

<?include
file: ../brand/messaging.md
Expand All @@ -21,18 +23,43 @@ extract: vscode-overview.text
The extension is a thin LSP client over the bundled mdsmith binary, which it runs with the lsp subcommand. Diagnostics appear inline as squiggles, and every fixable rule contributes a lightbulb quick fix. A whole-buffer fix action runs on demand or on save, with an optional Refactor Preview before edits land. Cross-file navigation extends to Go to Definition, Find All References, workspace symbol search, and a call hierarchy across includes, catalogs, builds, and Markdown links. The mdsmith Command Palette runs Initialize Config, Fix All Markdown, Install Git Merge Driver, Explain Rule on This File, and Show Resolved Config. The .vsix bundles the mdsmith binary for every supported OS and architecture, so no separate install is needed.
<?/include?>

The same `.vsix` is published to Open VSX, so Cursor, VSCodium,
Theia, and Gitpod install it too.
The same `.vsix` ships on Open VSX, so Cursor, VSCodium, Theia,
and Gitpod install it too. The
[Obsidian plugin](../guides/editors/obsidian.md) runs the engine
as WebAssembly, on desktop and mobile.

The Claude Code plugin marketplace ships `mdsmith-lsp`, which
feeds the same diagnostics and navigation to the agent, plus a
Markdown-organization audit skill. The agent sees mdsmith inline
while it edits your docs.
In Claude Code, mdsmith shows the agent the same diagnostics CI
runs: broken links, missing anchors, and heading or schema
violations. The agent catches and fixes them as it writes, before
the change reaches your review.

Pair the plugin with the [progressive disclosure
guide](../guides/progressive-disclosure.md): a `<?catalog?>`
keeps `CLAUDE.md` a one-line-per-doc index of your docs tree.
The marketplace ships five plugins. `mdsmith-lsp` gives the agent
inline diagnostics and the navigation the editor gets.
`mdsmith-autofix` runs `mdsmith fix` after every Markdown edit, so
generated sections and formatting stay correct with no manual
step. Three slash commands run the CLI from the prompt:
`/mdsmith-fix`, `/mdsmith-check`, and `/mdsmith-kinds`. A
`markdown-reviewer` subagent reviews Markdown PRs and drafts for
structural drift. The `/markdown-audit` skill audits a
repository's file layout: hand-kept indexes, missing kinds, and
absent schemas.

See the [VS Code guide](../guides/editors/vscode.md), the
[Obsidian guide](../guides/editors/obsidian.md), and the
[install guide](../guides/install.md) for setup.
Register the marketplace once, then install the plugins you want:

```text
/plugin marketplace add jeduden/mdsmith
```

The [install guide](../guides/install.md#claude-code-plugins)
lists the per-plugin install commands and prerequisites. mdsmith
makes no network call of its own; each plugin only runs the local
binary (see the [telemetry policy](../reference/telemetry.md)).

Pair the plugins with
[progressive disclosure](../guides/progressive-disclosure.md). A
`<?catalog?>` in `CLAUDE.md` keeps one summary line per tracked
doc. The agent reads that index up front, then opens only the
files a task touches.

See the [VS Code guide](../guides/editors/vscode.md) and the
[Obsidian guide](../guides/editors/obsidian.md) for editor setup.
Loading