solidity-language-server AGENTS.md

Repository guidance for working on a Solidity language server, which provides code navigation features for Solidity, a smart-contract programming language. It explains how compiler-generated syntax-tree identifiers and stable file identifiers work.

In plain words
What is it for?
Use it when modifying or reviewing the language server's syntax-tree identity, caching, or code-navigation logic, and when inspecting compiler JSON with jq.
Why use it?
It helps prevent confusing symbols from different compiler runs, which could make navigation or caching point to the wrong function. It also lists prerequisites for changing features such as definition lookup, references, renaming, and call hierarchies.

Instructions file for CodexOpenCode

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/asyncswap/solidity-language-server/agents-md
Clone the repo
git clone --depth 1 https://github.com/asyncswap/solidity-language-server

Made for: Codex, OpenCode.

Per session 3,184 This file is loaded in full into every session.
When invoked 3,184 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.03184 $0.03184
Opus 5 $0.01592 $0.01592
Sonnet 5 $0.00637 $0.00637
Haiku 4.5 $0.00318 $0.00318

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

Security

Grade A, and why

solidity-language-server AGENTS.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.

AGENTS.md · 287 lines

How it starts

The opening of the file, as written. The whole thing — 287 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Agents

  • Use jq to analyze json outputs from ast.
  • poolmanager.json - ast generated by solc (single-file build fixture for PoolManager).

Prerequisites: AST Identity Model

Before working on any feature that touches goto-definition, references, call hierarchy, implementation, rename, or the caching system, you must understand how file IDs and node IDs work. Getting this wrong causes cross-build collisions that are extremely hard to debug (a function in one build silently maps to a completely different function in another build).

The two ID types

Type Defined in Inner Assigned by Stable across compilations?
FileId(u64) types.rs:24 unsigned 64-bit PathInterner (canonical) Yes — same path always gets same ID
NodeId(i64) types.rs:4 signed 64-bit solc (per-compilation) No — same function can get different IDs

There is also SolcFileId(String) — a string wrapper used as HashMap keys matching solc's JSON output (e.g. "0", "34"). It is the stringified form of a file ID.

Node IDs are signed because solc uses negative IDs for built-in symbols (-1 for abi, -15 for msg, -18 for require, -28 for this).

The src string format

Every AST node has a src field in the format "offset:length:fileId":

  • offset — byte offset from the start of the source file
  • length — byte length of the source range
  • fileId — which source file this location belongs to

Parsed by SourceLoc::parse() in types.rs. After canonicalization, fileId is a canonical FileId from the PathInterner, not solc's original per-compilation ID.

Why file IDs are unstable from solc

Solc assigns file IDs sequentially based on input order. If you compile Foo.sol first, it gets ID 0. If you compile Bar.sol first, Foo.sol gets a different ID. A single-file build of PoolManager.sol produces different file IDs than a full project build that includes all 160 source files.

Read the full file on GitHub · 287 lines

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 · 287 lines · 3,184 tokens per session scan A 026773c2bc46

Subscribe to this mod's changes

solidity-language-server AGENTS.md is an instructions file published in the GitHub repository asyncswap/solidity-language-server (21 stars, last pushed 1mo ago), licensed MIT. It adds 3,184 tokens to every session, about $0.0159 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-30.