What is remnawave-mcp-server AGENTS.md?

A project-specific instruction guide for a Python server that connects an AI assistant to the Remnawave VPN panel API. It lists the project structure, supported Python versions, setup commands, and ways to run or inspect the server.

Use it when developing, installing, running, or debugging the Remnawave MCP server, including its VPN user, node, host, and statistics management integration.

It gives the coding agent the project rules and commands it needs instead of making it infer them from the repository. This helps avoid incorrect setup and incompatible changes.

How ssasuoirafen/remnawave-mcp-server configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to ssasuoirafen/remnawave-mcp-server. 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/ssasuoirafen/remnawave-mcp-server/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/ssasuoirafen/remnawave-mcp-server

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/ssasuoirafen/remnawave-mcp-server/agents-md/github.svg)](https://agentmods.dev/instructions/ssasuoirafen/remnawave-mcp-server/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/ssasuoirafen/remnawave-mcp-server/agents-md"><img src="https://agentmods.dev/badge/instructions/ssasuoirafen/remnawave-mcp-server/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.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/ssasuoirafen/remnawave-mcp-server/agents-md"><img src="https://agentmods.dev/badge/instructions/ssasuoirafen/remnawave-mcp-server/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 2,352 This file is loaded in full into every session.

When invoked 2,352 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 100% copy Near-identical to another mod 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.02352	$0.02352
Opus 5.5	$0.00941	$0.00941
Sonnet 5.5	$0.00470	$0.00470
Haiku 4.5	$0.00235	$0.00235

Measured 1mo ago against content hash 4eb818930640, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

remnawave-mcp-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 1mo 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.

Origin

This is a copy

100% identical to remnawave-mcp-server CLAUDE.md — 106 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

AGENTS.md · 106 lines

How it starts

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

Remnawave MCP Server

Project Overview

MCP (Model Context Protocol) server for the Remnawave VPN panel API. Written in Python 3.12+ using the mcp[cli] 2.x SDK (MCPServer, formerly FastMCP), httpx, and Pydantic 2.0+. Targets panel 3.2.x (verified live against 3.2.1 on 2026-08-07; see "3.x compatibility"). The panel no longer serves an OpenAPI spec: /docs-json returns the SPA HTML on 3.x (docs config was removed from env) - verify endpoint shapes empirically against the live panel or the remnawave/backend source at the deployed tag.

Python policy: package supports 3.12+ (see requires-python and classifiers); local development is pinned to 3.14 via .python-version. Keep these three in sync when bumping: bump classifiers whenever .python-version moves to a new minor; bump requires-python only when intentionally dropping older versions.

Used by the xray-vpn project (see its .mcp.json / settings.json) to manage users, nodes, hosts, stats.

Commands

# Install dependencies
uv sync

# Run the server standalone
uv run remnawave-mcp

# Run via MCP inspector (for debugging)
npx @modelcontextprotocol/inspector uv run remnawave-mcp

Environment Variables

REMNAWAVE_API_URL - panel root URL (no /api suffix; the client prefixes /api/... on every request)
REMNAWAVE_API_USERNAME - login username
REMNAWAVE_API_PASSWORD - login password
REMNAWAVE_TLS_VERIFY - optional; false/0/no disables TLS verification for self-signed panel certs (default: verification on)

Architecture

Entry point: src/remnawave_mcp/server.py - creates the MCPServer instance, initializes API client, registers all tool modules.

API client: src/remnawave_mcp/api_client.py - async HTTP client with bearer token auth and auto-refresh on 401. Provides request(), format_bytes(), handle_error(), and RemnawaveApiError (RuntimeError subclass with .status_code for tools that branch on HTTP status). request() returns None for 204/empty-body responses.

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

1mo ago First seen · 106 lines · 2,352 tokens per session scan A 4eb818930640

Subscribe to this mod's changes

remnawave-mcp-server AGENTS.md is an instructions file published in the GitHub repository ssasuoirafen/remnawave-mcp-server (1 stars, last pushed 1mo ago), licensed MIT. It adds 2,352 tokens to every session, about $0.0094 per session on Opus 5.5. A static security scan graded it A with 0 findings. It is 100% identical to remnawave-mcp-server CLAUDE.md, differing in 106 lines, and is treated as a copy.

Backend and APIs Languages Python

remnawave-mcp-server AGENTS.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
remnawave-mcp-server AGENTS.mdssasuoirafen/remnawave-mcp-server	Instructions file	1	1mo ago	MIT	A	2,352	Codex, OpenCode
graftcode graftcode-python.instructions.mdgrft-dev/graftcode	Instructions file	967	1mo ago	none	A	4,639	GitHub Copilot
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	yesterday	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot

remnawave-mcp-server: Instructions file for Codex