What is Openship-App AGENTS.md?

Project instructions for Openship-App, an unofficial Android client for Openship, a self-hosted deployment platform. They describe its Kotlin Multiplatform structure, Compose interface, and communication methods.

Use them before changing the Android interface, shared code, API clients, deployment actions, or real-time event handling.

They help contributors understand the project boundaries and follow its existing architecture when making changes.

Openship-App AGENTS.md — Instructions file for Codex and OpenCode by kareemessam09: Project instructions for Openship-App, an unofficial And

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/kareemessam09/openship-app/agents-md

Clone the repo

git clone --depth 1 https://github.com/kareemessam09/Openship-App

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.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/kareemessam09/openship-app/agents-md.svg)](https://agentmods.dev/instructions/kareemessam09/openship-app/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/kareemessam09/openship-app/agents-md"><img src="https://agentmods.dev/badge/instructions/kareemessam09/openship-app/agents-md.svg" alt="Measured on agentmods" height="20"></a>

Per session 4,367 This file is loaded in full into every session.

When invoked 4,367 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.

Model	Per session	Once invoked
Fable 5.1	$0.04367	$0.04367
Opus 5	$0.02184	$0.02184
Sonnet 5	$0.00873	$0.00873
Haiku 4.5	$0.00437	$0.00437

Measured 5d ago against content hash 593f2a9e5d4a, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-05, from the pricing page.

Security

Grade A, and why

Openship-App 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 5d 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 · 337 lines

How it starts

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

Openship-App — Agent Instructions

Source of truth for AI agents working in this repository. Read this before making any changes. For full API contract details, see README.md.

Project Overview

Openship-App is an unofficial Android client for Openship, the open-source self-hostable deployment platform. Built with Kotlin Multiplatform (KMP) and Compose Multiplatform, using the Model Context Protocol (MCP) as the primary API layer and Server-Sent Events (SSE) for real-time streaming.

License: Apache-2.0
Status: v0.1 read-only complete; v0.2 MCP redeploy/rollback complete; release packaging done (R8 minified per-ABI APKs). Unofficial community client.
Relationship: Unofficial community client for Openship — not affiliated unless upstream says otherwise

Architecture & Protocol Strategy

androidApp/ (Android only)          shared/ (KMP)
┌──────────────────────┐            ┌──────────────────────────────┐
│  Compose UI          │            │  commonMain/                 │
│  - Screens           │───────────▶│  - client/ (REST, SSE, MCP)  │
│  - Navigation        │            │  - model/ (data classes)     │
│  - ViewModels        │            │  - repository/               │
│  - Koin DI           │            │  - util/                     │
│  - Lifecycle         │            │                              │
└──────────────────────┘            │  androidMain/                │
                                    │  - platform/ (Keystore,      │
                                    │    OkHttp engine)            │
                                    └──────────────────────────────┘

Phased API design:

Phase 1 (Active — Base v0.1.0): Resilient REST endpoints (/api/health/env, /api/projects, /api/deployments, /api/system/servers) with parallelized coroutine fetching + SSE (Ktor SSE plugin) for real-time streams: build/deploy logs (/api/deployments/:id/stream) and host monitoring (/api/system/monitor/stream).
Phase 2 (Roadmap — v0.2.0+): Model Context Protocol (MCP) (/api/mcp) for AI-native agent tooling and automated operations using the official Kotlin MCP SDK (io.modelcontextprotocol:kotlin-sdk-client 0.15.0).
One shared HttpClient with infinite timeouts on streaming channels and AES-256 token persistence.

Read the full file on GitHub · 337 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.

5d ago First seen · 337 lines · 4,367 tokens per session scan A 593f2a9e5d4a

Subscribe to this mod's changes

Openship-App AGENTS.md is an instructions file published in the GitHub repository kareemessam09/Openship-App (11 stars, last pushed 10d ago), licensed Apache-2.0. It adds 4,367 tokens to every session, about $0.0218 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.

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 · 6,785 tokens

Openship-App AGENTS.md

Getting it into your agent

Wrote this? Show the measurements

What it costs to keep this loaded

Grade A, and why

Nothing flagged

How it starts

Openship-App — Agent Instructions

Project Overview

Architecture & Protocol Strategy

What this file has done since we first saw it

Other instructions, from other repositories

vscode buildNext.instructions.md

spec-kit AGENTS.md

next.js AGENTS.md

codex AGENTS.md

langchain AGENTS.md

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