Skip to content

Commit 6a07fd8

Browse files
jonathanMLDevzho
andauthored
chore(release): v0.2.0 — changelog, migration, npm alignment (#116)
* chore(release): v0.2.0 — changelog, migration, npm alignment * fix package-lock.json --------- Co-authored-by: zho <jornathanm910923@gmail.com>
1 parent 297eb32 commit 6a07fd8

5 files changed

Lines changed: 53 additions & 16 deletions

File tree

CHANGELOG.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ Tagged releases are published to npm from GitHub Actions when a **GitHub Release
88

99
## [Unreleased]
1010

11+
## [0.2.0] - 2026-05-29
12+
1113
### Changed
1214

1315
- Package root export is the generic **core** layer (`setupCoreServer`); full CLI parity uses `@will-cppa/pinecone-read-only-mcp/alliance` (`setupAllianceServer`, built-in URL generators). `resolveConfig` uses env when set, else defaults: index **`rag-hybrid`**, rerank **`bge-reranker-v2-m3`** (constants `DEFAULT_INDEX_NAME` / `DEFAULT_RERANK_MODEL` in `src/core/config.ts`).
@@ -99,7 +101,8 @@ details. Newer shipped changes are recorded in this changelog by version.
99101
- Environment variable support
100102
- Full documentation and examples
101103

102-
[Unreleased]: https://github.com/cppalliance/pinecone-read-only-mcp-typescript/compare/v0.1.6...HEAD
104+
[Unreleased]: https://github.com/cppalliance/pinecone-read-only-mcp-typescript/compare/v0.2.0...HEAD
105+
[0.2.0]: https://github.com/cppalliance/pinecone-read-only-mcp-typescript/compare/v0.1.6...v0.2.0
103106
[0.1.6]: https://github.com/cppalliance/pinecone-read-only-mcp-typescript/compare/v0.1.1...v0.1.6
104107
[0.1.1]: https://github.com/cppalliance/pinecone-read-only-mcp-typescript/compare/v0.1.0...v0.1.1
105108
[0.1.0]: https://github.com/cppalliance/pinecone-read-only-mcp-typescript/releases/tag/v0.1.0

README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@
77

88
A Model Context Protocol (MCP) server that provides semantic search over Pinecone vector databases using hybrid search (dense + sparse) with reranking.
99

10+
**Current version: 0.2.0** (npm `latest` after publish). Pin `@0.2.0` in install and MCP config for reproducible upgrades.
11+
12+
## Upgrading from 0.1.x
13+
14+
Version **0.2.0** includes breaking MCP and type changes. See [docs/MIGRATION.md](docs/MIGRATION.md) for before/after examples and the [CHANGELOG](CHANGELOG.md#020---2026-05-29) **Changed** section for the full list.
15+
1016
## Documentation
1117

1218
| Doc | Description |
@@ -44,7 +50,7 @@ For successful `query`, `query_documents`, and `guided_query` payloads, **rerank
4450
- **Dynamic Namespace Discovery**: Automatically discovers available namespaces in your Pinecone index
4551
- **Metadata Filtering**: Supports optional metadata filters for refined searches
4652
- **Fast presets**: Lazy initialization, connection pooling, and efficient result merging; use the `query` tool `preset=fast | detailed | full` to trade latency vs quality (no published benchmarks yet — treat descriptions as qualitative).
47-
- **Production-oriented defaults**: Input validation, error handling, and configurable logging (semantic versioning is pre-1.0review CHANGELOG before upgrading).
53+
- **Production-oriented defaults**: Input validation, error handling, and configurable logging; upgrading from **0.1.x**see [MIGRATION.md](docs/MIGRATION.md).
4854
- **TypeScript Support**: Full TypeScript support with type definitions
4955

5056
## Installation
@@ -54,25 +60,25 @@ For successful `query`, `query_documents`, and `guided_query` payloads, **rerank
5460
### As a Package
5561

5662
```bash
57-
npm install @will-cppa/pinecone-read-only-mcp
63+
npm install @will-cppa/pinecone-read-only-mcp@0.2.0
5864
```
5965

6066
Or using yarn:
6167

6268
```bash
63-
yarn add @will-cppa/pinecone-read-only-mcp
69+
yarn add @will-cppa/pinecone-read-only-mcp@0.2.0
6470
```
6571

6672
Or using pnpm:
6773

6874
```bash
69-
pnpm add @will-cppa/pinecone-read-only-mcp
75+
pnpm add @will-cppa/pinecone-read-only-mcp@0.2.0
7076
```
7177

7278
### Global Installation
7379

7480
```bash
75-
npm install -g @will-cppa/pinecone-read-only-mcp
81+
npm install -g @will-cppa/pinecone-read-only-mcp@0.2.0
7682
```
7783

7884
### From Source
@@ -182,7 +188,7 @@ Add to your `claude_desktop_config.json`:
182188
"mcpServers": {
183189
"pinecone-search": {
184190
"command": "npx",
185-
"args": ["-y", "@will-cppa/pinecone-read-only-mcp"],
191+
"args": ["-y", "@will-cppa/pinecone-read-only-mcp@0.2.0"],
186192
"env": {
187193
"PINECONE_API_KEY": "your-api-key-here",
188194
"PINECONE_INDEX_NAME": "your-index-name",
@@ -202,7 +208,7 @@ Or with explicit options:
202208
"command": "npx",
203209
"args": [
204210
"-y",
205-
"@will-cppa/pinecone-read-only-mcp",
211+
"@will-cppa/pinecone-read-only-mcp@0.2.0",
206212
"--api-key",
207213
"your-api-key-here",
208214
"--index-name",
@@ -235,7 +241,7 @@ For a global installation:
235241
Run the server using npx (no installation required):
236242

237243
```bash
238-
npx @will-cppa/pinecone-read-only-mcp --api-key YOUR_API_KEY
244+
npx @will-cppa/pinecone-read-only-mcp@0.2.0 --api-key YOUR_API_KEY
239245
```
240246

241247
Or if installed globally:
@@ -275,10 +281,10 @@ Run `pinecone-read-only-mcp --help` for the full option list.
275281

276282
```bash
277283
# install
278-
npm i @will-cppa/pinecone-read-only-mcp
284+
npm i @will-cppa/pinecone-read-only-mcp@0.2.0
279285

280286
# run
281-
npx @will-cppa/pinecone-read-only-mcp --api-key YOUR_API_KEY
287+
npx @will-cppa/pinecone-read-only-mcp@0.2.0 --api-key YOUR_API_KEY
282288
```
283289

284290
### Deploy with Docker

docs/MIGRATION.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# Migration guide
22

3-
This guide is for **library and MCP client authors** upgrading from earlier **0.1.x** lines. The `[Unreleased]` section of [`CHANGELOG.md`](../CHANGELOG.md) is the authoritative list of changes; this document shows **how** to migrate.
3+
This guide is for **library and MCP client authors** upgrading from earlier **0.1.x** lines. The **[0.2.0]** section of [`CHANGELOG.md`](../CHANGELOG.md) is the authoritative list of changes; this document shows **how** to migrate.
44

5-
## Migrating to v0.2.0 (upcoming)
5+
Under [semver 0.y.z](https://semver.org/spec/v2.0.0.html#spec-item-4), **0.1.x → 0.2.0 is a breaking minor** — pin `@0.2.0` only after reading this guide.
6+
7+
## Migrating to v0.2.0
68

79
### Namespace trimming and suggest-flow
810

@@ -120,10 +122,23 @@ await callTool('query', {
120122

121123
---
122124

125+
### 5. Node.js >= 20.12.0
126+
127+
**Rationale:** `engines.node` is now **>=20.12.0**. Vitest **4** (bundled **rolldown**) imports `util.styleText` from `node:util` (added in Node **20.12**), and **`@vitest/coverage-v8`** uses `node:inspector/promises`. CI tests **20.x** and **22.x** only.
128+
129+
**Migration steps:**
130+
131+
1. Upgrade local Node to **20.12+** (or **22.x**).
132+
2. Update CI images / `actions/setup-node` to **20.12+** if you pin an older 20.x patch.
133+
3. Re-run your MCP client or library tests after upgrading.
134+
135+
---
136+
123137
## Summary checklist
124138

125139
- [ ] Normalize and reuse namespace strings across suggest + gated tools.
126140
- [ ] Adopt `ToolError` parsing for all tool failures.
127141
- [ ] Remove reliance on in-body `status: 'error'` for query responses.
128142
- [ ] Update `recommended_tool` handling to `count` \| `fast` \| `detailed` \| `full`.
129143
- [ ] Map legacy fast/detailed tool calls to `query` + `preset`.
144+
- [ ] Run on Node.js **>=20.12.0**.

package-lock.json

Lines changed: 15 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@will-cppa/pinecone-read-only-mcp",
3-
"version": "0.1.6",
3+
"version": "0.2.0",
44
"description": "A Model Context Protocol (MCP) server that provides semantic search over Pinecone vector databases using hybrid search (dense + sparse) with reranking.",
55
"type": "module",
66
"main": "dist/core/index.js",

0 commit comments

Comments
 (0)