ballerina-vscode: Instructions file for Codex

AGENTS.md

ballerina-vscode AGENTS.md is an instructions file for Codex, OpenCode from ballerina-platform/ballerina-vscode. It costs 3,623 tokens per session, scanned A, original, Apache-2.0.

A repository guide for AI coding agents working in a Rush.js monorepo. A monorepo is one repository containing multiple related projects, and Rush is the tool this project uses to manage them.

In plain words
What is it for?
Use it when changing the Ballerina VS Code project, installing dependencies, understanding its package layout, or following its build and contribution rules.
Why use it?
It prevents agents from using the wrong dependency commands or missing build requirements across the extension, language server, grammar, and supporting packages.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: mentions Claude Code; built for aider.

This is ballerina-platform/ballerina-vscode's own configuration. It tells Codex and OpenCode how to work on ballerina-vscode itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything ballerina-vscode configures →

Reuse

Borrowing it

Nothing to install: this file belongs to ballerina-platform/ballerina-vscode. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/ballerina-platform/ballerina-vscode/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/ballerina-platform/ballerina-vscode

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for ballerina-vscode AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/ballerina-platform/ballerina-vscode/agents-md/github.svg)](https://agentmods.dev/instructions/ballerina-platform/ballerina-vscode/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/ballerina-platform/ballerina-vscode/agents-md"><img src="https://agentmods.dev/badge/instructions/ballerina-platform/ballerina-vscode/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for ballerina-vscode AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/ballerina-platform/ballerina-vscode/agents-md"><img src="https://agentmods.dev/badge/instructions/ballerina-platform/ballerina-vscode/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 3,623 This file is loaded in full into every session.
When invoked 3,623 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.03623 $0.03623
Opus 5.5 $0.01449 $0.01449
Sonnet 5.5 $0.00725 $0.00725
Haiku 4.5 $0.00362 $0.00362

Measured 3d ago against content hash 5b1fb9216c9a, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

ballerina-vscode 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 3d 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 · 241 lines

How it starts

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

Agent guide

For AI coding agents (Claude Code, Cursor, Aider, etc.) operating in this repo. This file captures the things that aren't obvious from reading the code and that agents repeatedly get wrong on their first try.

Human contributors should read CONTRIBUTING.md first. This document assumes that context.

Project shape in one paragraph

ballerina-vscode is a rush.js monorepo combining the Ballerina VS Code extension (packages/ballerina-extension), its Gradle-built Java language server (packages/ballerina-language-server), the TextMate grammar (packages/ballerina-grammar), and ~20 supporting webview / diagram TypeScript packages also under packages/. Shared @wso2/* libraries are consumed via a git submodule at submodules/wso2-vscode-extensions/ pinned to the release/ballerina-5.12.x branch. Rush treats both packages/* and a handful of common-libs inside the submodule as workspace projects.

Rules of engagement

1. Use rush. Don't run npm install or pnpm install directly.

rush update is the only way to install dependencies. Running pnpm or npm directly will diverge from common/config/rush/pnpm-lock.yaml and produce ambiguous failures the next time someone runs rush.

2. The full build needs LS prerequisites.

rush build                                       # everything (equivalent to --to ballerina)
rush build --to ballerina-language-server        # LS only
rush build --to @wso2/ballerina-visualizer       # one package + its deps (skips LS + extension)

All 27 projects in rush.json are reachable from ballerina-extension, so rush build and rush build --to ballerina build the same set. Either form requires:

  • Java 25 on JAVA_HOME
  • packageUser/packagePAT in ~/.gradle/gradle.properties (or the env)

If you don't have those set up, skip the LS by building one of its dependents directly, e.g. rush build --to @wso2/ballerina-visualizer — that skips both ballerina-extension and the LS.

Read the full file on GitHub · 241 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. 3d ago First seen · 241 lines · 3,623 tokens per session scan A 5b1fb9216c9a

Subscribe to this mod's changes

ballerina-vscode AGENTS.md is an instructions file published in the GitHub repository ballerina-platform/ballerina-vscode (49 stars, last pushed today), licensed Apache-2.0. It adds 3,623 tokens to every session, about $0.0145 per session on Opus 5.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-10-26.

Related

Other instructions, from other repositories

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 9,715 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,461 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,750 tokens

deno copilot-instructions.md

Copilot instructions for denoland/deno, covering deno development guide for github copilot, network access, high level overview, key directories and key files to understand first.

denoland/deno · 3,077 tokens