Notes-mcp

A small TypeScript-based CLI project that builds to ./build and exposes a notes-mcp binary.

Requirements

• Node.js (LTS recommended)
• npm

Install

Install dependencies:

npm install

Build

Compile the TypeScript sources into the build/ folder:

npm run build

The build script (from package.json) runs the TypeScript compiler and sets executable permissions on the generated CLI bundle:

tsc && chmod 755 build/index.js

Run

• Run the built CLI directly with Node:

node build/index.js

• Or make the CLI available system-wide during development:

npm link
# then run
notes-mcp

Project structure

• package.json - project manifest (includes build script and bin mapping)
• tsconfig.json - TypeScript configuration
• src/ - TypeScript source files
  • src/index.ts - main entry
  • src/utils.ts - helpers
• build/ - compiled output (committed via files list)
  • build/index.js - compiled CLI entry
  • build/utils.js - compiled helpers

Development

• Edit files in src/ and re-run npm run build to update build/.
• Type definitions are available via @types/node in devDependencies.

Publishing / Packaging

The package includes only the build/ folder (see files in package.json). Before publishing, ensure build/ contains the compiled and executable index.js.

Contributing

Contributions are welcome. Open an issue or submit a pull request with a clear description of the change.

License

This project is licensed under the ISC license (see package.json).