monocle AGENTS.md

A contribution guide for monocle, a read-only Swift code inspection tool built on SourceKit-LSP. It explains the project’s structure, development rules, and build process.

In plain words
What is it for?
Understanding how monocle resolves Swift symbols, following repository instructions, formatting changed Swift files, and building the project.
Why use it?
It gives contributors the context needed to change the project consistently and verify that their changes compile.

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/swiftedmind/monocle/agents-md
Clone the repo
git clone --depth 1 https://github.com/SwiftedMind/monocle

Made for: Codex, OpenCode.

Per session 787 This file is loaded in full into every session.
When invoked 787 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.00787 $0.00787
Opus 5 $0.00394 $0.00394
Sonnet 5 $0.00157 $0.00157
Haiku 4.5 $0.00079 $0.00079

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

Security

Grade A, and why

monocle 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 · 82 lines

How it starts

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

AGENTS.md — Architecture & Contribution Guide

monocle is a read-only Swift code inspection tool built on top of SourceKit-LSP.
Its primary purpose is to provide a command-line equivalent of “cmd-click” in an IDE: given a file, line, and column, it resolves the symbol there and returns information about its definition and documentation.

This document gives a high-level view of how the project is structured and how it is intended to evolve, so that contributors can extend it without breaking the overall design.


General Instructions

Pay attention to these general instructions and closely follow them!

  • Always prefer readability over conciseness/compactness.
  • Never commit unless instructed to do so.

When you are done

  • Always build the project to check for compilation errors.
  • When you have added or modified Swift files, always run swiftformat --config ".swiftformat" {files}.

Build Instructions

  • Build from the repository root with swift build.
  • Prefer swift build --quiet to reduce noise; only drop --quiet when debugging a failure.

1. Purpose and Scope

  • Inspect Swift symbols at a given file/line/column.
  • Resolve definitions across the workspace, including packages and dependencies.
  • Surface signatures and documentation via SourceKit-LSP.
  • Operate in a read-only manner: no edits, no refactorings, no code generation.

The tool focuses on understanding existing Swift code, not modifying it.


2. High-Level Architecture

The project is structured into clear layers to keep responsibilities separate while allowing the daemon/server to build on the same foundations.

2.1 Core Layer

The core layer encapsulates all interaction with SourceKit-LSP and the workspace:

  • Manages the lifecycle of an LSP session (starting and shutting down sourcekit-lsp).
  • Sends LSP requests (e.g. “go to definition”, “hover”) and parses responses.
  • Resolves the workspace (SwiftPM or Xcode) from file paths or an explicit root.
  • Provides a small, stable API for “inspect the symbol at this location”.

Read the full file on GitHub · 82 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 · 82 lines · 787 tokens per session scan A fe737ce95115

Subscribe to this mod's changes

monocle AGENTS.md is an instructions file published in the GitHub repository SwiftedMind/monocle (50 stars, last pushed 7mo ago), licensed MIT. It adds 787 tokens to every session, about $0.0039 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.