Report · marked 26 Aug 2026

ehang-io/nps

An agent can work here, but it will waste turns finding its footing.

Go · 34,174 stars · 170 files · branch master

66 /100 B

Instructions 3/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file and instruction quality.Setup 14/14Whether an agent can install the project and get it running without a human. Full marks.Verification loop 15/22Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on tests exist and lint and format rules.Context economy 19/20Whether the repo fits in a context window, or fights it. Losing marks on .gitignore hygiene.Navigability 10/10How quickly anything new can orient itself. Full marks.

Higher is better. Accent marks what is costing you most.

Fix these first

Agent instruction file

Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.

Instruction quality

Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.

Tests exist

Coverage is thin enough that an agent can break real behavior and still see green.

The full marking

Every deduction below names the file or setting it came from.

Instructions 3/27 F

Whether the repo tells an agent how to behave before it starts guessing.

✗Agent instruction file 0/12

None found. Every agent that opens this repo starts from zero.

Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.

Looked for AGENTS.md, CLAUDE.md, .github/copilot-instructions.md, .cursorrules

✗Instruction quality 0/12

Nothing to judge, since there are no instructions.

Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.

✓README as an entry point 3/3

README has a clear getting-started section.

Setup 14/14 A+

Whether an agent can install the project and get it running without a human.

✓Deterministic install 6/6

go.sum pins the dependency tree.

Found go.sum

✓Discoverable commands 6/6

Commands are declared where an agent will look for them.

Makefile

–Environment config n/a

Not applicable — this reads as a library, with no environment to configure.

✓Pinned runtime version 2/2

The language runtime version is pinned.

go.mod declares a Go version

–Reproducible environment n/a

Not applicable — a library doesn't need a container to be worked on.

Verification loop 15/22 B

Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.

✗Tests exist 4/8

3 test files against 67 source files.

Coverage is thin enough that an agent can break real behavior and still see green.

e.g. lib/config/config_test.go, lib/pmux/pmux_test.go, server/test/test.go

✓Test command is discoverable 7/7

An agent can find and run `make test`.

✓Continuous integration 4/4

1 GitHub Actions workflow define what "passing" means.

✗Lint and format rules 0/3

No linter or formatter config. Style is tribal knowledge, so agent output will drift from yours.

A formatter config is the cheapest way to stop reviewing whitespace in agent diffs. It moves style from opinion to a command.

–Static type checking n/a

Not applicable — the Go compiler type checks every build.

Context economy 19/20 A+

Whether the repo fits in a context window, or fights it.

✓No committed build output 6/6

No generated directories committed.

✗.gitignore hygiene 2/3

.gitignore has only 3 rules.

Start from a standard template for your stack. It prevents the previous problem before it happens.

✓File sizes fit in context 6/6

No source file is large enough to crowd out a context window.

✓Repository weight 5/5

About 9.2MB checked out, which is comfortable.

Here is your AGENTS.md

Drafted from what is actually in this repository: the install command from your lockfile, the commands you already declare, your real directory layout. Anything marked TODO needs a person. Save it at the root as AGENTS.md.

AGENTS.md — drafted for ehang-io/nps

# AGENTS.md

一款轻量级、高性能、功能强大的内网穿透代理服务器。支持tcp、udp、socks5、http等几乎所有流量转发，可用来访问内网网站、本地支付接口调试、ssh访问、远程桌面，内网dns解析、内网socks5代理等等……，并带有功能强大的web管理端。a lightweight, high-performance, powerful intranet penetration proxy server, with a powerful web management terminal.

## Setup

```
go mod download
```

## Commands

```
make build   # produce a build
make setup
make test    # run the test suite, must pass before any commit
make cover
make fmt
make lint    # lint
```

## Layout

- `lib/`    33 source files
- `server/` 13 source files
- `web/`    8 source files
- `client/` 5 source files
- `cmd/`    3 source files
- `bridge/` 1 source file

## Conventions

- Tests live alongside the code they cover, following `lib/config/config_test.go`.
- CI defines what passing means. See `.github/workflows/release.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.

Open the raw markdown or curl -o AGENTS.md agentreadme.com/draft/ehang-io/nps.md

Show the mark

The badge re-checks daily, so it keeps up as the repository changes. Use mark again to force it now.

[![agent ready](https://agentreadme.com/badge/ehang-io/nps.svg)](https://agentreadme.com/ehang-io/nps)

Other Go repositories, marked

avelino/awesome-go 78 A- ollama/ollama 85 A golang/go 31 D kubernetes/kubernetes 72 B+ microsoft/TypeScript 82 A- fatedier/frp 96 A+

All Go repositories

Think this mark is wrong?

Every deduction above names the file it came from, so this can be settled by looking. If a check missed something, that is a rule worth fixing.

Open an issue, already filled in