Skip to content

Use make targets in the README development instructions - #54

Merged
ericof merged 1 commit into
mainfrom
readme-make-targets
Jul 27, 2026
Merged

Use make targets in the README development instructions#54
ericof merged 1 commit into
mainfrom
readme-make-targets

Conversation

@ericof

@ericof ericof commented Jul 27, 2026

Copy link
Copy Markdown
Member

What

Replaces the raw pnpm commands documented in the README with their make equivalents, and adds the targets that were missing from the Makefile to make that possible.

Changes

README

  • The HTTP transport is started with make start.
  • The local development clone block uses make install / make build.
  • The development commands block is fully converted to make, and now points at make help for the complete target list.
  • The troubleshooting entry for a failing local build points at make install.

Makefile — three new targets:

Target Runs
stdio pnpm run stdio — the STDIO server from dist/
inspector npx @modelcontextprotocol/inspector node dist/stdio-server.js
test-all pnpm test — the whole suite; make test stays unit-only

Note on two dropped commands

The README documented pnpm run dev ("development mode with hot reload") and pnpm run inspector. Neither script exists in package.json, so both lines were stale. They are dropped rather than wrapped in a target:

  • make inspector uses the raw npx invocation the README already documented further down, so no capability is lost.
  • There is no hot-reload equivalent. If we want one, it needs a real script (e.g. tsx watch src/stdio-server.ts) — happy to add it in a follow-up.

Verification

  • make help lists every target.
  • make test-all → 186 tests passing across 31 files.

The one remaining pnpm mention in the README is prose explaining that the package manager is only needed for local development — not a command, so it stays.

Replace the raw pnpm commands documented in the README with their make
equivalents, and add the stdio, inspector and test-all targets that were
missing from the Makefile.

The stale 'pnpm run dev' and 'pnpm run inspector' commands are dropped:
neither script exists in package.json.
@ericof
ericof requested a review from tisto July 27, 2026 14:17
@ericof
ericof merged commit c851a4d into main Jul 27, 2026
3 checks passed
@ericof
ericof deleted the readme-make-targets branch July 27, 2026 14:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant