Skip to content

Commit 8335005

Browse files
jonathanMLDevzho
andauthored
chore(release): prepare v0.4.0 (#190)
* chore(release): prepare v0.4.0 * chore(release): prepare v0.4.0 * fixed depend errors * fixed format error --------- Co-authored-by: zho <jornathanm910923@gmail.com>
1 parent af31af4 commit 8335005

9 files changed

Lines changed: 467 additions & 395 deletions

File tree

CHANGELOG.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,16 @@ Tagged releases are published to npm from GitHub Actions when a **GitHub Release
88

99
## [Unreleased]
1010

11+
## [0.4.0] - 2026-06-24
12+
1113
### Added
1214

13-
- **Multi-source mode:** configure multiple Pinecone API keys / indexes in one MCP server via `PINECONE_SOURCES`, `--sources`, or a JSON config file (`PINECONE_CONFIG_FILE` / `--config-file`). New `list_sources` tool (when more than one source is configured). Optional `source` parameter on discovery and query tools; `list_namespaces` aggregates across sources and tags each namespace with `source`. See [CONFIGURATION.md](docs/CONFIGURATION.md#multi-source-mode), [TOOLS.md](docs/TOOLS.md#multi-source-mode), and deployment profiles in [CONFIGURATION.md](docs/CONFIGURATION.md#deployment-profiles).
15+
- **Multi-source mode:** configure multiple Pinecone API keys / indexes in one MCP server via `PINECONE_SOURCES`, `--sources`, or a JSON config file (`PINECONE_CONFIG_FILE` / `--config-file`). New `list_sources` tool (when more than one source is configured). Optional `source` parameter on discovery and query tools; `list_namespaces` aggregates across sources and tags each namespace with `source`. See [CONFIGURATION.md](docs/CONFIGURATION.md#multi-source-mode), [TOOLS.md](docs/TOOLS.md#multi-source-mode), and deployment profiles in [CONFIGURATION.md](docs/CONFIGURATION.md#deployment-profiles). Migration: [MIGRATION.md § 0.4.0 multi-source](docs/MIGRATION.md#040-multi-source-pinecone-projects).
1416

1517
### Changed
1618

17-
- **Library:** `resolveConfig()` returns `CoreServerConfig`; `resolveAllianceConfig()` returns `AllianceServerConfig`. `setupCoreServer` / `setupAllianceServer` accept only their respective branded config and context types (`CoreServerContext` / `AllianceServerContext`). `ServerConfig` remains an alias for `ServerConfigBase` on read paths (`ctx.getConfig()`). See [MIGRATION.md](docs/MIGRATION.md#unreleased-branded-serverconfig-types).
19+
- **Breaking (types):** `resolveConfig()` returns `CoreServerConfig`; `resolveAllianceConfig()` returns `AllianceServerConfig`. `setupCoreServer` / `setupAllianceServer` accept only their respective branded config and context types (`CoreServerContext` / `AllianceServerContext`). `ServerConfig` remains an alias for `ServerConfigBase` on read paths (`ctx.getConfig()`). See [MIGRATION.md § 0.4.0 branded ServerConfig](docs/MIGRATION.md#040-branded-serverconfig-types).
20+
- **Library (internal):** Query and `keyword_search` response Zod schemas consolidated to a single canonical schema per type; permissive variants are derived via `.partial()` (no MCP payload shape change). See comment in `src/core/server/response-schemas.ts`.
1821

1922
## [0.3.0] - 2026-06-23
2023

@@ -141,7 +144,8 @@ details. Newer shipped changes are recorded in this changelog by version.
141144
- Environment variable support
142145
- Full documentation and examples
143146

144-
[Unreleased]: https://github.com/cppalliance/pinecone-read-only-mcp-typescript/compare/v0.3.0...HEAD
147+
[Unreleased]: https://github.com/cppalliance/pinecone-read-only-mcp-typescript/compare/v0.4.0...HEAD
148+
[0.4.0]: https://github.com/cppalliance/pinecone-read-only-mcp-typescript/compare/v0.3.0...v0.4.0
145149
[0.3.0]: https://github.com/cppalliance/pinecone-read-only-mcp-typescript/compare/v0.2.0...v0.3.0
146150
[0.2.0]: https://github.com/cppalliance/pinecone-read-only-mcp-typescript/compare/v0.1.6...v0.2.0
147151
[0.1.6]: https://github.com/cppalliance/pinecone-read-only-mcp-typescript/compare/v0.1.1...v0.1.6

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,15 @@
77

88
A [Model Context Protocol](https://modelcontextprotocol.io) (MCP) server that implements the MCP specification via `@modelcontextprotocol/sdk` v1.25+ and provides semantic search over Pinecone vector databases using hybrid search (dense + sparse) with reranking.
99

10-
Current version: 0.3.0 (npm `latest` after publish). Pin `@0.3.0` in install and MCP config for reproducible upgrades.
10+
Current version: 0.4.0 (npm `latest` after publish). Pin `@0.4.0` in install and MCP config for reproducible upgrades.
11+
12+
## Upgrading to 0.4.0
13+
14+
Version **0.4.0** adds **multi-source mode** (`PINECONE_SOURCES`, `list_sources`, optional `source` on query tools) and **breaking (types)** branded `CoreServerConfig` / `AllianceServerConfig``setupCoreServer` and `setupAllianceServer` now accept only matching config/context types. See [docs/MIGRATION.md](docs/MIGRATION.md#040-multi-source-pinecone-projects), [docs/MIGRATION.md § branded ServerConfig](docs/MIGRATION.md#040-branded-serverconfig-types), and the [CHANGELOG](CHANGELOG.md#040---2026-06-24).
1115

1216
## Upgrading to 0.3.0
1317

14-
Version **0.3.0** includes breaking MCP and library changes: experimental response fields nested under `experimental`, branded `CoreServerConfig` / `AllianceServerConfig`, legacy module-facade deprecations, and core `resolveConfig` requiring an index name with suggest-flow off by default. See [docs/MIGRATION.md](docs/MIGRATION.md) for before/after examples and the [CHANGELOG](CHANGELOG.md#030---2026-06-23) **Changed** section for the full list.
18+
Version **0.3.0** includes breaking MCP and library changes: experimental response fields nested under `experimental`, legacy module-facade deprecations, and core `resolveConfig` requiring an index name with suggest-flow off by default. See [docs/MIGRATION.md](docs/MIGRATION.md) for before/after examples and the [CHANGELOG](CHANGELOG.md#030---2026-06-23) **Changed** section for the full list.
1519

1620
## Upgrading from 0.1.x
1721

@@ -70,25 +74,25 @@ For successful `query`, `query_documents`, and `guided_query` payloads, **rerank
7074
### As a Package
7175

7276
```bash
73-
npm install @will-cppa/pinecone-read-only-mcp@0.3.0
77+
npm install @will-cppa/pinecone-read-only-mcp@0.4.0
7478
```
7579

7680
Or using yarn:
7781

7882
```bash
79-
yarn add @will-cppa/pinecone-read-only-mcp@0.3.0
83+
yarn add @will-cppa/pinecone-read-only-mcp@0.4.0
8084
```
8185

8286
Or using pnpm:
8387

8488
```bash
85-
pnpm add @will-cppa/pinecone-read-only-mcp@0.3.0
89+
pnpm add @will-cppa/pinecone-read-only-mcp@0.4.0
8690
```
8791

8892
### Global Installation
8993

9094
```bash
91-
npm install -g @will-cppa/pinecone-read-only-mcp@0.3.0
95+
npm install -g @will-cppa/pinecone-read-only-mcp@0.4.0
9296
```
9397

9498
### From Source
@@ -256,7 +260,7 @@ Add to your `claude_desktop_config.json`:
256260
"mcpServers": {
257261
"pinecone-search": {
258262
"command": "npx",
259-
"args": ["-y", "@will-cppa/pinecone-read-only-mcp@0.3.0"],
263+
"args": ["-y", "@will-cppa/pinecone-read-only-mcp@0.4.0"],
260264
"env": {
261265
"PINECONE_API_KEY": "your-api-key-here",
262266
"PINECONE_INDEX_NAME": "your-index-name",
@@ -276,7 +280,7 @@ Or with explicit options:
276280
"command": "npx",
277281
"args": [
278282
"-y",
279-
"@will-cppa/pinecone-read-only-mcp@0.3.0",
283+
"@will-cppa/pinecone-read-only-mcp@0.4.0",
280284
"--api-key",
281285
"your-api-key-here",
282286
"--index-name",
@@ -309,7 +313,7 @@ For a global installation:
309313
Run the server using npx (no installation required):
310314

311315
```bash
312-
npx @will-cppa/pinecone-read-only-mcp@0.3.0 --api-key YOUR_API_KEY --index-name YOUR_INDEX
316+
npx @will-cppa/pinecone-read-only-mcp@0.4.0 --api-key YOUR_API_KEY --index-name YOUR_INDEX
313317
```
314318

315319
Or if installed globally:
@@ -349,10 +353,10 @@ Run `pinecone-read-only-mcp --help` for the full option list.
349353

350354
```bash
351355
# install
352-
npm i @will-cppa/pinecone-read-only-mcp@0.3.0
356+
npm i @will-cppa/pinecone-read-only-mcp@0.4.0
353357

354358
# run
355-
npx @will-cppa/pinecone-read-only-mcp@0.3.0 --api-key YOUR_API_KEY
359+
npx @will-cppa/pinecone-read-only-mcp@0.4.0 --api-key YOUR_API_KEY
356360
```
357361

358362
### Deploy with Docker

docs/MIGRATION.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ See [deprecation-policy.md § Active deprecations](./deprecation-policy.md#activ
169169

170170
When `PINECONE_SOURCES` or a config file is active, legacy module facades (`getNamespacesWithCache`, `registerUrlGenerator`, `markSuggested`, `requireSuggested`, etc.) operate on the **default source only** (first inline source, or `defaultSource` from JSON). They do not aggregate across projects. Prefer an explicit `ServerContext` built with `sourceRegistry` from `buildSourceRegistry()` for multi-tenant or multi-project embedding.
171171

172-
## Unreleased: Multi-source Pinecone projects
172+
## 0.4.0: Multi-source Pinecone projects
173173

174174
**Who is affected:** Operators running separate MCP entries per Pinecone project, or library embedders needing multiple indexes.
175175

@@ -372,7 +372,7 @@ Core `resolveConfig` throws `Missing Pinecone index name: …` when the index is
372372

373373
---
374374

375-
## Unreleased: Branded ServerConfig types
375+
## 0.4.0: Branded ServerConfig types
376376

377377
**Rationale:** `resolveConfig()` and `resolveAllianceConfig()` produced structurally identical configs. Passing Alliance-resolved config or context into `setupCoreServer()` compiled but silently changed suggest-flow gate behavior (and related defaults).
378378

docs/deprecation-policy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ For step-by-step upgrades, see [MIGRATION.md](./MIGRATION.md). For publish mecha
1010

1111
## Semantic versioning while `0.y.z`
1212

13-
This package currently ships as **`0.y.z`**. Under [Semantic Versioning §4](https://semver.org/spec/v2.0.0.html#spec-item-4), **minor releases may include breaking changes** until the first `1.0.0` release. Consumers should **pin an exact version** (for example `@will-cppa/pinecone-read-only-mcp@0.3.0`) in `package.json`, MCP server config, and Docker tags.
13+
This package currently ships as **`0.y.z`**. Under [Semantic Versioning §4](https://semver.org/spec/v2.0.0.html#spec-item-4), **minor releases may include breaking changes** until the first `1.0.0` release. Consumers should **pin an exact version** (for example `@will-cppa/pinecone-read-only-mcp@0.4.0`) in `package.json`, MCP server config, and Docker tags.
1414

1515
After **`1.0.0`**, this project intends to follow standard semver: breaking changes land only in **major** releases, and the deprecation window below becomes **binding** for removals that were previously announced as deprecated.
1616

0 commit comments

Comments
 (0)