Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (31 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

44 lines (31 loc) · 1.45 KB
Raw

Contributing

This is a thin MCP client over the public Noteboxd API.

Development

pnpm install --ignore-workspace
cp .env.example .env            # add your NOTEBOXD_API_KEY
node --env-file=.env --import tsx src/index.ts   # or: NOTEBOXD_API_KEY=... pnpm dev
pnpm build
pnpm typecheck

To test against a client, point it at node dist/index.js with NOTEBOXD_API_KEY set.

Scope

This package only wraps public api.noteboxd.com/v1 endpoints. Please keep it that way:

  • No internal routes, service tokens, or scraping.
  • Each tool maps to one public endpoint. If the API adds an endpoint, add a matching tool in src/tools.ts.
  • Tools stay read-only.

Releasing

Releases are automated by .github/workflows/release.yml on a version tag. It publishes to npm via Trusted Publishing (OIDC, no token) and to the official MCP Registry via DNS auth.

  1. Bump the version in package.json, server.json, and src/config.ts (keep them equal).
  2. Commit and push, then push an annotated tag (push the tag explicitly — git push --follow-tags skips lightweight tags): 
    git commit -am "release: vX.Y.Z"
git push
git tag -a vX.Y.Z -m "vX.Y.Z"
git push origin vX.Y.Z

The workflow checks the tag matches the file versions before publishing.

Issues

Include the tool name, the arguments, and the response you got. Do not paste your real API key.