agentleFS
CyrusNuevoDiaCyrusNuevoDia/skill-language-server/AGENTS.md

skill-language-server

AGENTS.md7 starsChanged 4 months agoMITView on GitHub

An LSP server for agent skill files (skills/<name>/SKILL.md): go-to-definition, find-references, hover, completion, diagnostics, and cross-file rename for /skill-name and $skill-name references. Rename is the flagship feature — one WorkspaceEdit renames the skill folder (RenameFile), the frontmatter name: value, and every reference across the workspace. The test suite is the contract. Definition of done: bun install + just check all clean — run them, never grade from memory. Spec decisions live in this file and in the tests; change tests only…

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 31,700 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository4 other files it gives its agents.

The file

We split this AGENTS.md into the rules it gives an agent

1 rule. About 0 are common, 0 are distinctive, and 1 is 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.

  • 1

    Very specific

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

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

    All disk I/O is async (node:fs/promises).

    line 85

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md 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
AGENTS.md

What this is

An LSP server for agent skill files (skills/<name>/SKILL.md): go-to-definition, find-references, hover, completion, diagnostics, and cross-file rename for /skill-name and $skill-name references. Rename is the flagship feature — one WorkspaceEdit renames the skill folder (RenameFile), the frontmatter name: value, and every reference across the workspace.

The test suite is the contract. Definition of done: bun install + just check all clean — run them, never grade from memory. Spec decisions live in this file and in the tests; change tests only when the spec itself changes, stated out loud, never to make an implementation pass.

Commands

Tools come from mise (mise trust && mise install on first checkout).

CommandWhat
bun testFull suite; single file: bun test tests/rename.test.ts; single test: bun test -t "rename rejects"
just checktsc (root + vscode-extension) + ultracite lint + the full test suite
just fmtultracite fix --unsafe — ALWAYS use this instead of fixing format/lint complaints by hand
just buildAll artifacts into dist/: standalone binary, VS Code .vsix, Zed wasm
just binBuild + install server binary to ~/.local/bin/skill-language-server (what Zed launches)

Verifier = bun install + just check all clean. Run it before declaring anything done. After server changes, refresh installed clients: just bin (Zed) and just build && cursor --install-extension dist/skill-language-server.vsix (Cursor). Use Cursor for native verification of the VS Code-family extension.

TypeScript is v7 (native compiler): @types/* packages must be listed explicitly in each tsconfig's "types" field — they are not auto-discovered.

Coding style

Formatting/lint is ultracite's job — just fmt, never hand-fix. The conventions a formatter can't see are written down in docs/typescript.md (function shape, naming, arktype/arkregex/es-toolkit idioms, the tsc-v7 never-CFA gotcha) and docs/bun.md (Bun $/Bun.file idioms for scripts/). Read them before writing code. The load-bearing boundary: src/ and ext/ must stay Node-compatible (node:* imports only, no Bun globals — they ship to npm, the VS Code extension host, and Zed's Node); scripts/ is Bun-native and typechecked via the root tsconfig.

Architecture

Server modules in src/ are layered:

  • schema.ts / completion.ts — the checked-in skill-frontmatter catalog and its completion projection. Every catalog variant records YAML types, source, and client scope; finite values live there too. .claude paths receive universal plus Claude fields, .agents/.codex receive only universal fields, and generic skills paths receive scope-labelled compatible candidates. Schema completion runs only at top-level key/value positions in valid SKILL.md frontmatter, never repeats an existing key, and always supplies an explicit prefix-only textEdit.
  • parse.ts — pure text → {frontmatter, links, tokens}. Owns the token grammar: [/$] + [a-z0-9_] segments joined by runs of - or : (separators may repeat but never lead/trail), rejected when preceded by a word/path/scheme/home/XML-close char (~ included, so ~/scripts never matches; < included, so </tag> is not a skill reference) or followed by / (so /usr/bin, $PATH, https://x never match). Fenced code blocks are skipped with CommonMark pairing — only a closer with the same marker char and at least the opening length ends a fence (a ~~~ line inside a ``` block is content); inline code spans are NOT (people write `/skill` in prose). Inline Markdown links are represented separately from sigil tokens; images, reference-style links, malformed links, and links inside fenced/inline code are excluded, while escaped/nested punctuation and angle destinations retain source-accurate destination ranges. XML balance scanning supports nested and same-name tags, quoted/multiline attributes, self-closing and void HTML elements, comments, CDATA, processing instructions, and declarations. It skips fenced/inline code and Markdown autolinks, and reports exact tag-name ranges with deterministic recovery from mismatched nesting. Frontmatter delimiter and YAML semantics are gray-matter's: delimiters sit at column 0, and an indented --- in a block scalar is content; fields are parsed as YAML 1.1 nodes and salvaged per key, so malformed or wrong-typed fields never erase independently usable ones. Source-backed key/value ranges exclude value quotes and trailing comments. Structural diagnostics cover missing/malformed/unclosed frontmatter, required/empty fields, duplicate top-level keys, every client-applicable catalog field's YAML type, and name syntax; the same parsed name: range remains the rename declaration target.
  • workspace.ts — the index. Walks the workspace once (scan()), keyed maps files (by URI) and skills (by name, array-valued to track duplicates). All disk I/O is async (node:fs/promises); only indexFile (pure text → index) is sync. The walker follows symlinks — indexing the SYMLINK-side path, never the target — with an ancestor-chain realpath guard (not a global visited set: two non-cyclic routes to the same dir are both legal; only a loop back into an ancestor terminates). Broken symlinks are skipped silently. Scope rule lives in inScope(): a file is indexed iff its path contains a .claude, .agents, .codex, or skills segment (or is named CLAUDE.md / AGENTS.md) AND is not matched by a workspace-root .skillignore (gitignore syntax; live-reloaded via the file watcher). This repo's own .skillignore excludes tests/fixtures/ so fixture skills don't pollute editors opening this repo. Skill identity is the FOLDER name; frontmatter name: disagreeing is a diagnostic, not an alias. Duplicate names track every twin: a position on a declaration resolves to the twin defined in THAT file (rename from a duplicate's frontmatter renames its own folder), while references resolve to the first-indexed twin. All reported ranges cover the name part only, never the sigil. Unresolved /references get info-level hints, near misses (edit distance ≤ 2) upgrade to did you mean warnings; builtin CLI command names (src/builtins.ts) and workspace .claude/commands/.codex/prompts names are exempt from both; $ tokens get near-miss warnings but never the info hint. Relative Markdown destinations resolve from their containing file after percent-decoding and stripping query/fragment suffixes. Existing files/directories are valid; missing local destinations are warnings. Destination-resolved skill directories and SKILL.md files are explicit SkillReference variants and join definition, references, highlighting, and rename without collapsing their syntax into sigil tokens.
  • server.ts — LSP wiring only; no logic that isn't protocol shaped. Rename emits text edits BEFORE the folder RenameFile (clients apply sequentially; the frontmatter edit targets a file inside the folder being renamed). RenameFile is gated on the client declaring EITHER workspaceEdit.documentChanges OR resourceOperations: ["rename"] — Neovim only declares the latter; a client declaring neither gets a plain changes map (per spec that's all it supports). Renaming to the current name is a no-op (null), never a self-RenameFile. willRenameFiles handles explorer-drag renames (returns compensating edits, no RenameFile echo). Skill hover on declarations, sigil references, and destination-resolved Markdown skill links shows the canonical name, valid non-empty description, and workspace-relative SKILL.md path; declaration hover uses its own duplicate while references use the first-indexed duplicate. Broken-link quick fixes only correct exact case or one unique same-extension sibling within edit distance 2; they preserve suffixes and never create filesystem resources. Open buffers are authoritative over disk until didClose, which reverts to disk truth (an unsaved close leaves no watcher event). The watcher also registers **/skills/* because a recursive folder delete arrives as one event for the folder itself, which **/*.md never matches. Completion items carry an explicit textEdit — -/: are word delimiters in markdown, so client-side word replacement would mangle multi-segment names. Diagnostics are published ONLY when non-empty, plus exactly one clearing empty publish when a URI transitions back to clean — clean files are never published (Neovim materializes a phantom buffer per published URI). All sends route through the one publish() helper. Because index mutations are async, a single promise-chain queue serializes them: notification handlers enqueue, every request handler awaits the queue tail first — this is what makes a request round-trip (the test harness's settle()) prove that all earlier notifications' effects, including publishes, have landed.

Tests are protocol-level, not unit-level: tests/helpers/harness.ts boots the real server over in-memory streams and speaks JSON-RPC to it. tests/corpus.ts is the ground truth of every reference in the fixture workspace (tests/fixtures/workspace/) — if you add/move a reference in a fixture, update corpus.ts, not individual test expectations. Fixtures encode the edge cases deliberately (near-miss typo, fenced block, inline code, out-of-scope docs/guide.md, duplicate deploy skills, builtin-shadowing modal skill, custom command files); don't "clean them up".

Distribution targets in ext/ (thin shims around the same server):

  • ext/vscode/ — bundles the server INTO the .vsix (dist/server.js), spawns it over IPC. Attaches to all markdown; the server self-filters.
  • ext/zed/ — Rust/WASM shim. Prefers skill-language-server on PATH (the just bin dev workflow); otherwise auto-installs the npm package into the extension's work dir and runs it on Zed's bundled Node (needs engines >=22, which Zed's runtime satisfies — don't tighten it). Installed as a dev extension via zed: install dev extension.
  • ext/nvim/ — plain Lua plugin for Neovim 0.11+ (lsp/skill-language-server.lua + vim.lsp.enable); expects the just bin binary on PATH.

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.