feat: validate manifest version during pack command
Add validation to ensure the manifest_version matches the current expected version (0.2) during the mcpb pack command. This prevents users from packing extensions with outdated or incorrect manifest versions. Changes: - Add CURRENT_MANIFEST_VERSION constant to centralize version management - Validate manifest version in pack command before creating bundle - Update init command to use version constant - Update tests to use version constant - Fix prettier formatting issues
This commit is contained in:
parent
2825da1d6a
commit
f92fe4ab69
9 changed files with 70 additions and 47 deletions
|
|
@ -1,8 +1,9 @@
|
|||
# MCP Bundles (MCPB)
|
||||
|
||||
> **⚠️ IMPORTANT NOTICE: This project is being renamed from DXT (Desktop Extensions) to MCPB (MCP Bundles)**
|
||||
>
|
||||
>
|
||||
> If you're looking for the DXT tools, they have been renamed to MCPB. Please update your dependencies and tooling:
|
||||
>
|
||||
> - `dxt` CLI is now `mcpb`
|
||||
> - `.dxt` files are now `.mcpb` files
|
||||
> - `@anthropic-ai/dxt` package will be moved to `@anthropic-ai/mcpb`
|
||||
|
|
@ -154,4 +155,4 @@ npm test
|
|||
|
||||
# License
|
||||
|
||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||
|
|
|
|||
|
|
@ -80,4 +80,4 @@
|
|||
"@babel/parser": "7.27.3"
|
||||
},
|
||||
"packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,4 +1,7 @@
|
|||
import { McpbManifestSchema, McpbSignatureInfoSchema } from "../dist/schemas.js";
|
||||
import {
|
||||
McpbManifestSchema,
|
||||
McpbSignatureInfoSchema,
|
||||
} from "../dist/schemas.js";
|
||||
import * as z from "zod/v4";
|
||||
import fs from "node:fs/promises";
|
||||
import path from "node:path";
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@ import { confirm, input, select } from "@inquirer/prompts";
|
|||
import { existsSync, readFileSync, writeFileSync } from "fs";
|
||||
import { basename, join, resolve } from "path";
|
||||
|
||||
import { CURRENT_MANIFEST_VERSION } from "../schemas.js";
|
||||
import type { McpbManifest } from "../types.js";
|
||||
|
||||
interface PackageJson {
|
||||
|
|
@ -773,7 +774,7 @@ export function buildManifest(
|
|||
const { keywords, license, repository } = optionalFields;
|
||||
|
||||
return {
|
||||
manifest_version: "0.1",
|
||||
manifest_version: CURRENT_MANIFEST_VERSION,
|
||||
name,
|
||||
...(displayName && displayName !== name
|
||||
? { display_name: displayName }
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ import { basename, join, relative, resolve, sep } from "path";
|
|||
|
||||
import { getAllFilesWithCount, readMcpbIgnorePatterns } from "../node/files.js";
|
||||
import { validateManifest } from "../node/validate.js";
|
||||
import { McpbManifestSchema } from "../schemas.js";
|
||||
import { CURRENT_MANIFEST_VERSION, McpbManifestSchema } from "../schemas.js";
|
||||
import { getLogger } from "../shared/log.js";
|
||||
import { initExtension } from "./init.js";
|
||||
|
||||
|
|
@ -101,6 +101,17 @@ export async function packExtension({
|
|||
return false;
|
||||
}
|
||||
|
||||
const manifestVersion = manifest.manifest_version || manifest.dxt_version;
|
||||
if (manifestVersion !== CURRENT_MANIFEST_VERSION) {
|
||||
logger.error(
|
||||
`ERROR: Manifest version mismatch. Expected "${CURRENT_MANIFEST_VERSION}", found "${manifestVersion}"`,
|
||||
);
|
||||
logger.error(
|
||||
` Please update the manifest_version in your manifest.json to "${CURRENT_MANIFEST_VERSION}"`,
|
||||
);
|
||||
return false;
|
||||
}
|
||||
|
||||
// Determine output path
|
||||
const extensionName = basename(resolvedPath);
|
||||
const finalOutputPath = outputPath
|
||||
|
|
|
|||
|
|
@ -79,38 +79,39 @@ export const McpbUserConfigValuesSchema = z.record(
|
|||
export const McpbManifestSchema = z
|
||||
.object({
|
||||
$schema: z.string().optional(),
|
||||
dxt_version: z.string().optional().describe("@deprecated Use manifest_version instead"),
|
||||
dxt_version: z
|
||||
.string()
|
||||
.optional()
|
||||
.describe("@deprecated Use manifest_version instead"),
|
||||
manifest_version: z.string().optional(),
|
||||
name: z.string(),
|
||||
display_name: z.string().optional(),
|
||||
version: z.string(),
|
||||
description: z.string(),
|
||||
long_description: z.string().optional(),
|
||||
author: McpbManifestAuthorSchema,
|
||||
repository: McpbManifestRepositorySchema.optional(),
|
||||
homepage: z.string().url().optional(),
|
||||
documentation: z.string().url().optional(),
|
||||
support: z.string().url().optional(),
|
||||
icon: z.string().optional(),
|
||||
screenshots: z.array(z.string()).optional(),
|
||||
server: McpbManifestServerSchema,
|
||||
tools: z.array(McpbManifestToolSchema).optional(),
|
||||
tools_generated: z.boolean().optional(),
|
||||
prompts: z.array(McpbManifestPromptSchema).optional(),
|
||||
prompts_generated: z.boolean().optional(),
|
||||
keywords: z.array(z.string()).optional(),
|
||||
license: z.string().optional(),
|
||||
compatibility: McpbManifestCompatibilitySchema.optional(),
|
||||
user_config: z
|
||||
.record(z.string(), McpbUserConfigurationOptionSchema)
|
||||
.optional(),
|
||||
name: z.string(),
|
||||
display_name: z.string().optional(),
|
||||
version: z.string(),
|
||||
description: z.string(),
|
||||
long_description: z.string().optional(),
|
||||
author: McpbManifestAuthorSchema,
|
||||
repository: McpbManifestRepositorySchema.optional(),
|
||||
homepage: z.string().url().optional(),
|
||||
documentation: z.string().url().optional(),
|
||||
support: z.string().url().optional(),
|
||||
icon: z.string().optional(),
|
||||
screenshots: z.array(z.string()).optional(),
|
||||
server: McpbManifestServerSchema,
|
||||
tools: z.array(McpbManifestToolSchema).optional(),
|
||||
tools_generated: z.boolean().optional(),
|
||||
prompts: z.array(McpbManifestPromptSchema).optional(),
|
||||
prompts_generated: z.boolean().optional(),
|
||||
keywords: z.array(z.string()).optional(),
|
||||
license: z.string().optional(),
|
||||
compatibility: McpbManifestCompatibilitySchema.optional(),
|
||||
user_config: z
|
||||
.record(z.string(), McpbUserConfigurationOptionSchema)
|
||||
.optional(),
|
||||
})
|
||||
.refine(
|
||||
(data) => !!(data.dxt_version || data.manifest_version),
|
||||
{
|
||||
message: "Either 'dxt_version' (deprecated) or 'manifest_version' must be provided",
|
||||
}
|
||||
);
|
||||
.refine((data) => !!(data.dxt_version || data.manifest_version), {
|
||||
message:
|
||||
"Either 'dxt_version' (deprecated) or 'manifest_version' must be provided",
|
||||
});
|
||||
|
||||
export const McpbSignatureInfoSchema = z.object({
|
||||
status: z.enum(["signed", "unsigned", "self-signed"]),
|
||||
|
|
|
|||
|
|
@ -1,5 +1,7 @@
|
|||
import * as z from "zod";
|
||||
|
||||
export const CURRENT_MANIFEST_VERSION = "0.2";
|
||||
|
||||
export const McpServerConfigSchema = z.strictObject({
|
||||
command: z.string(),
|
||||
args: z.array(z.string()).optional(),
|
||||
|
|
@ -79,7 +81,10 @@ export const McpbUserConfigValuesSchema = z.record(
|
|||
export const McpbManifestSchema = z
|
||||
.strictObject({
|
||||
$schema: z.string().optional(),
|
||||
dxt_version: z.string().optional().describe("@deprecated Use manifest_version instead"),
|
||||
dxt_version: z
|
||||
.string()
|
||||
.optional()
|
||||
.describe("@deprecated Use manifest_version instead"),
|
||||
manifest_version: z.string().optional(),
|
||||
name: z.string(),
|
||||
display_name: z.string().optional(),
|
||||
|
|
@ -106,12 +111,10 @@ export const McpbManifestSchema = z
|
|||
.record(z.string(), McpbUserConfigurationOptionSchema)
|
||||
.optional(),
|
||||
})
|
||||
.refine(
|
||||
(data) => !!(data.dxt_version || data.manifest_version),
|
||||
{
|
||||
message: "Either 'dxt_version' (deprecated) or 'manifest_version' must be provided",
|
||||
}
|
||||
);
|
||||
.refine((data) => !!(data.dxt_version || data.manifest_version), {
|
||||
message:
|
||||
"Either 'dxt_version' (deprecated) or 'manifest_version' must be provided",
|
||||
});
|
||||
|
||||
export const McpbSignatureInfoSchema = z.strictObject({
|
||||
status: z.enum(["signed", "unsigned", "self-signed"]),
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@ import { execSync } from "node:child_process";
|
|||
import fs from "node:fs";
|
||||
import { join } from "node:path";
|
||||
|
||||
import { CURRENT_MANIFEST_VERSION } from "../src/schemas.js";
|
||||
|
||||
interface ExecSyncError extends Error {
|
||||
stdout: Buffer;
|
||||
stderr: Buffer;
|
||||
|
|
@ -91,7 +93,7 @@ describe("DXT CLI", () => {
|
|||
fs.writeFileSync(
|
||||
join(tempDir, "manifest.json"),
|
||||
JSON.stringify({
|
||||
manifest_version: "1.0",
|
||||
manifest_version: CURRENT_MANIFEST_VERSION,
|
||||
name: "Test Extension",
|
||||
version: "1.0.0",
|
||||
description: "A test extension",
|
||||
|
|
@ -188,7 +190,7 @@ describe("DXT CLI", () => {
|
|||
fs.writeFileSync(
|
||||
join(tempExecDir, "manifest.json"),
|
||||
JSON.stringify({
|
||||
manifest_version: "1.0",
|
||||
manifest_version: CURRENT_MANIFEST_VERSION,
|
||||
name: "Test Executable Extension",
|
||||
version: "1.0.0",
|
||||
description: "A test extension with executable files",
|
||||
|
|
|
|||
|
|
@ -10,6 +10,7 @@ import {
|
|||
getDefaultRepositoryUrl,
|
||||
readPackageJson,
|
||||
} from "../src/cli/init.js";
|
||||
import { CURRENT_MANIFEST_VERSION } from "../src/schemas.js";
|
||||
|
||||
// Mock the fs module
|
||||
jest.mock("fs", () => ({
|
||||
|
|
@ -217,7 +218,7 @@ describe("init functions", () => {
|
|||
);
|
||||
|
||||
expect(manifest).toEqual({
|
||||
manifest_version: "0.1",
|
||||
manifest_version: CURRENT_MANIFEST_VERSION,
|
||||
name: "test-extension",
|
||||
version: "1.0.0",
|
||||
description: "Test description",
|
||||
|
|
@ -303,7 +304,7 @@ describe("init functions", () => {
|
|||
);
|
||||
|
||||
expect(manifest).toEqual({
|
||||
manifest_version: "0.1",
|
||||
manifest_version: CURRENT_MANIFEST_VERSION,
|
||||
name: "test-extension",
|
||||
display_name: "Test Extension",
|
||||
version: "1.0.0",
|
||||
|
|
|
|||
Loading…
Reference in a new issue