modelcontextprotocol/mcpb
Watch
1
0
Fork
You've already forked mcpb
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix: update schema to reflect manifest_version

Browse source
This commit is contained in:
Joan Xie 2025-08-25 21:09:45 -07:00
commit 76949836e0
No known key found for this signature in database
15 changed files with 72 additions and 56 deletions
Download patch file Download diff file Expand all files Collapse all files

8
MANIFEST.md
View file

@ -11,7 +11,7 @@ A basic `manifest.json` with just the required fields looks like this:
```json
{
"mcpb_version": "0.1", // MCPB spec version this manifest conforms to
"manifest_version": "0.1", // Manifest spec version this manifest conforms to
"name": "my-extension", // Machine-readable name (used for CLI, APIs)
"version": "1.0.0", // Semantic version of your extension
"description": "A simple MCP extension", // Brief description of what the extension does
@ -37,7 +37,7 @@ A basic `manifest.json` with just the required fields looks like this:
```json
{
"mcpb_version": "0.1",
"manifest_version": "0.1",
"name": "my-extension",
"version": "1.0.0",
"description": "A simple MCP extension",
@ -71,7 +71,7 @@ A full `manifest.json` with most of the optional fields looks like this:
```json
{
"mcpb_version": "0.1",
"manifest_version": "0.1",
"name": "My MCP Extension",
"display_name": "My Awesome MCP Extension",
"version": "1.0.0",
@ -162,7 +162,7 @@ A full `manifest.json` with most of the optional fields looks like this:
### Required Fields
- **mcpb_version**: Specification version this extension conforms to
- **manifest_version**: Specification version this extension conforms to
- **name**: Machine-readable name (used for CLI, APIs)
- **version**: Semantic version (semver)
- **description**: Brief description

4
examples/chrome-applescript/manifest.json
View file

@ -1,6 +1,6 @@
{
"$schema": "../../dist/dxt-manifest.schema.json",
"mcpb_version": "0.1",
"$schema": "../../dist/mcpb-manifest.schema.json",
"manifest_version": "0.1",
"name": "chrome-applescript",
"display_name": "Control Chrome with AppleScript",
"version": "0.1.0",

4
examples/file-manager-python/manifest.json
View file

@ -1,6 +1,6 @@
{
"$schema": "../../dist/dxt-manifest.schema.json",
"mcpb_version": "0.1",
"$schema": "../../dist/mcpb-manifest.schema.json",
"manifest_version": "0.1",
"name": "file-manager-python",
"display_name": "Python File Manager MCP",
"version": "0.1.0",

2
examples/file-system-node/manifest.json
View file

@ -1,5 +1,5 @@
{
"mcpb_version": "0.1",
"manifest_version": "0.1",
"id": "anthropic.demo.filesystem",
"name": "Filesystem",
"display_name": "Filesystem",

4
examples/hello-world-node/manifest.json
View file

@ -1,6 +1,6 @@
{
"$schema": "../../dist/dxt-manifest.schema.json",
"mcpb_version": "0.1",
"$schema": "../../dist/mcpb-manifest.schema.json",
"manifest_version": "0.1",
"name": "hello-world-node",
"display_name": "Hello World MCP Server (Reference Extension)",
"version": "0.1.0",

6
scripts/build-mcpb-schema.js
View file

@ -1,11 +1,11 @@
import { DxtManifestSchema, DxtSignatureInfoSchema } 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";
const schemasToWrite = {
"dxt-manifest": DxtManifestSchema,
"dxt-signature-info": DxtSignatureInfoSchema,
"mcpb-manifest": McpbManifestSchema,
"mcpb-signature-info": McpbSignatureInfoSchema,
};
await fs.mkdir(path.join(import.meta.dirname, "../dist"), { recursive: true });

2
src/cli/init.ts
View file

@ -773,7 +773,7 @@ export function buildManifest(
const { keywords, license, repository } = optionalFields;
return {
mcpb_version: "0.1",
manifest_version: "0.1",
name,
...(displayName && displayName !== name
? { display_name: displayName }

16
src/schemas-loose.ts
View file

@ -76,9 +76,11 @@ export const McpbUserConfigValuesSchema = z.record(
z.union([z.string(), z.number(), z.boolean(), z.array(z.string())]),
);
export const McpbManifestSchema = z.object({
$schema: z.string().optional(),
mcpb_version: z.string(),
export const McpbManifestSchema = z
.object({
$schema: z.string().optional(),
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(),
@ -102,7 +104,13 @@ export const McpbManifestSchema = z.object({
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",
}
);
export const McpbSignatureInfoSchema = z.object({
status: z.enum(["signed", "unsigned", "self-signed"]),

62
src/schemas.ts
View file

@ -76,33 +76,41 @@ export const McpbUserConfigValuesSchema = z.record(
z.union([z.string(), z.number(), z.boolean(), z.array(z.string())]),
);
export const McpbManifestSchema = z.strictObject({
$schema: z.string().optional(),
mcpb_version: z.string(),
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(),
});
export const McpbManifestSchema = z
.strictObject({
$schema: z.string().optional(),
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(),
})
.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"]),

4
test/cli.test.ts
View file

@ -91,7 +91,7 @@ describe("DXT CLI", () => {
fs.writeFileSync(
join(tempDir, "manifest.json"),
JSON.stringify({
mcpb_version: "1.0",
manifest_version: "1.0",
name: "Test Extension",
version: "1.0.0",
description: "A test extension",
@ -188,7 +188,7 @@ describe("DXT CLI", () => {
fs.writeFileSync(
join(tempExecDir, "manifest.json"),
JSON.stringify({
mcpb_version: "1.0",
manifest_version: "1.0",
name: "Test Executable Extension",
version: "1.0.0",
description: "A test extension with executable files",

4
test/config.test.ts
View file

@ -90,7 +90,7 @@ describe("getMcpConfigForManifest", () => {
};
const baseManifest: McpbManifest = {
mcpb_version: "1.0.0",
manifest_version: "1.0.0",
name: "test-extension",
version: "1.0.0",
description: "Test extension",
@ -305,7 +305,7 @@ describe("getMcpConfigForManifest", () => {
describe("hasRequiredConfigMissing", () => {
const baseManifest: McpbManifest = {
mcpb_version: "1.0.0",
manifest_version: "1.0.0",
name: "test-extension",
version: "1.0.0",
description: "Test extension",

4
test/init.test.ts
View file

@ -217,7 +217,7 @@ describe("init functions", () => {
);
expect(manifest).toEqual({
mcpb_version: "0.1",
manifest_version: "0.1",
name: "test-extension",
version: "1.0.0",
description: "Test description",
@ -303,7 +303,7 @@ describe("init functions", () => {
);
expect(manifest).toEqual({
mcpb_version: "0.1",
manifest_version: "0.1",
name: "test-extension",
display_name: "Test Extension",
version: "1.0.0",

2
test/invalid-manifest.json
View file

@ -1,5 +1,5 @@
{
"mcpb_version": "1.0",
"manifest_version": "1.0",
"name": "test-extension",
"version": "1.0.0",
"description": "A test DXT extension",

4
test/schemas.test.ts
View file

@ -37,7 +37,7 @@ describe("McpbManifestSchema", () => {
it("should validate manifest with all optional fields", () => {
const fullManifest = {
mcpb_version: "1.0",
manifest_version: "1.0",
name: "full-extension",
display_name: "Full Featured Extension",
version: "2.0.0",
@ -117,7 +117,7 @@ describe("McpbManifestSchema", () => {
serverTypes.forEach((type) => {
const manifest = {
mcpb_version: "1.0",
manifest_version: "1.0",
name: "test",
version: "1.0.0",
description: "Test",

2
test/valid-manifest.json
View file

@ -1,5 +1,5 @@
{
"mcpb_version": "1.0",
"manifest_version": "1.0",
"name": "test-extension",
"display_name": "Test Extension",
"version": "1.0.0",