lua-lsp CLAUDE.md

A project instruction file for a Lua language-server plugin, covering setup, important files, and automated checks.

In plain words
What is it for?
Use it to set up Lua development tools, configure the language server, understand the plugin's hooks, format and lint Lua files, and check for TODOs or excessive complexity.
Why use it?
It gives the coding agent the project context needed to work consistently and explains how formatting, linting, syntax checks, and quality checks are applied.

Instructions file

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/zircote/lua-lsp/claude-md
Clone the repo
git clone --depth 1 https://github.com/zircote/lua-lsp
Per session 327 This file is loaded in full into every session.
When invoked 327 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00327 $0.00327
Opus 5 $0.00163 $0.00163
Sonnet 5 $0.00065 $0.00065
Haiku 4.5 $0.00033 $0.00033

Measured 2d ago against content hash daca2f69b9b8, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

lua-lsp CLAUDE.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

CLAUDE.md · 44 lines

What it actually says

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

A Claude Code plugin providing Lua development support through lua-language-server LSP integration and 10 automated hooks for linting, formatting, and code quality.

Setup

Run /setup to install all required tools, or manually:

brew install lua-language-server  # macOS
cargo install stylua
luarocks install luacheck

Key Files

File Purpose
.lsp.json lua-language-server LSP configuration
hooks/hooks.json Automated development hooks
hooks/scripts/lua-hooks.sh Hook dispatcher script
commands/setup.md /setup command definition
.claude-plugin/plugin.json Plugin metadata

Hook System

All hooks trigger afterWrite. Hooks use command -v checks to skip gracefully when optional tools aren't installed.

Hook categories:

  • Formatting (**/*.lua): StyLua
  • Linting (**/*.lua): Luacheck, syntax validation
  • Quality (**/*.lua): TODO/FIXME detection, complexity checks

Conventions

  • Prefer minimal diffs
  • Keep hooks fast (use --check for validation, limit output with head)
  • Documentation changes: update both README.md and commands/setup.md if relevant
  • Follow Lua naming conventions (snake_case for functions, PascalCase for classes/modules)
Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 44 lines · 327 tokens per session scan A daca2f69b9b8

Subscribe to this mod's changes

lua-lsp CLAUDE.md is an instructions file published in the GitHub repository zircote/lua-lsp (1 stars, last pushed 23d ago), licensed MIT. It adds 327 tokens to every session, about $0.0016 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.