@novorb/mcp-core 2.1.0 → 2.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +27 -7
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -2,9 +2,10 @@
2
2
 
3
3
  ---
4
4
 
5
- [![npm](https://img.shields.io/badge/%40novorb%2Fmcp--core-2.1.0-blue)](https://www.npmjs.com/package/@novorb/mcp-core)
5
+ [![CI](https://github.com/Novorb/mcp-core/actions/workflows/ci.yml/badge.svg)](https://github.com/Novorb/mcp-core/actions/workflows/ci.yml)
6
+ [![npm](https://img.shields.io/npm/v/@novorb/mcp-core)](https://www.npmjs.com/package/@novorb/mcp-core)
6
7
  [![Node](https://img.shields.io/badge/Node-22%2B-green)](https://nodejs.org/)
7
- [![Tests](https://img.shields.io/badge/Tests-98-purple)]()
8
+ [![Tests](https://img.shields.io/badge/Tests-122-purple)]()
8
9
  [![License](https://img.shields.io/badge/License-MIT-yellow)](LICENSE)
9
10
 
10
11
  Shared TypeScript utilities for building MCP (Model Context Protocol) servers — logging, HTTP clients, retry logic, pagination, and transport — so every MCP server gets a consistent, tested foundation without reimplementing common patterns.
@@ -27,7 +28,7 @@ Shared TypeScript utilities for building MCP (Model Context Protocol) servers
27
28
  ## Installation
28
29
 
29
30
  ```bash
30
- npm install @novorb/mcp-core
31
+ pnpm add @novorb/mcp-core
31
32
  ```
32
33
 
33
34
  ## Modules
@@ -159,9 +160,9 @@ server.registerTool('lookup', {
159
160
  ## Testing
160
161
 
161
162
  ```bash
162
- npm test # 67 tests
163
- npm run test:watch # watch mode
164
- npm run test:coverage
163
+ pnpm test # 122 tests
164
+ pnpm run test:watch # watch mode
165
+ pnpm run test:coverage
165
166
  ```
166
167
 
167
168
  > **Windows note:** the test scripts set `NODE_OPTIONS=` inline, which is Unix shell syntax. On Windows, invoke jest directly via a bash shell. See [docs/TESTING.md](docs/TESTING.md).
@@ -169,11 +170,30 @@ npm run test:coverage
169
170
  ## Building
170
171
 
171
172
  ```bash
172
- npm run build # tsc → dist/
173
+ pnpm run build # tsc → dist/
173
174
  ```
174
175
 
175
176
  This is an ESM package (`"type": "module"`). `tsconfig.json` is self-contained so it builds standalone.
176
177
 
178
+ ## CI / Releasing
179
+
180
+ GitHub Actions (`.github/workflows/`):
181
+
182
+ - **CI** (`ci.yml`) — runs build + test on every push to `main` and on pull requests.
183
+ - **Publish** (`publish.yml`) — on a pushed version tag `v*`, runs build + test, verifies the
184
+ tag matches `package.json` `version`, then publishes to the public npm registry (with provenance).
185
+
186
+ Release flow:
187
+
188
+ ```bash
189
+ # 1. bump "version" in package.json (e.g. 2.1.1), commit
190
+ # 2. tag and push — the tag triggers the publish workflow
191
+ git tag v2.1.1 && git push origin v2.1.1
192
+ ```
193
+
194
+ Requires the repo secret **`NPM_TOKEN`** (an npm automation/granular token with publish rights for
195
+ the `@novorb` scope) under *Settings → Secrets and variables → Actions*.
196
+
177
197
  ## License
178
198
 
179
199
  [MIT](LICENSE)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@novorb/mcp-core",
3
- "version": "2.1.0",
3
+ "version": "2.1.1",
4
4
  "description": "Shared utilities for MCP servers — logger, HTTP client, retry, pagination, transport",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",