@fadlee/pocketbase-mcp 1.0.0

package/build/src/tools/schemas/collection.d.ts

@@ -0,0 +1,192 @@
+/**
+ * Tool input schemas for collection-related operations
+ */
+export declare const createCollectionSchema: {
+    type: string;
+    properties: {
+        name: {
+            type: string;
+            description: string;
+        };
+        type: {
+            type: string;
+            description: string;
+            enum: string[];
+            default: string;
+        };
+        fields: {
+            type: string;
+            description: string;
+            items: {
+                type: string;
+                properties: {
+                    name: {
+                        type: string;
+                        description: string;
+                    };
+                    type: {
+                        type: string;
+                        description: string;
+                        enum: string[];
+                    };
+                    required: {
+                        type: string;
+                        description: string;
+                    };
+                    system: {
+                        type: string;
+                        description: string;
+                    };
+                    unique: {
+                        type: string;
+                        description: string;
+                    };
+                    min: {
+                        type: string;
+                        description: string;
+                    };
+                    max: {
+                        type: string;
+                        description: string;
+                    };
+                    pattern: {
+                        type: string;
+                        description: string;
+                    };
+                    autogeneratePattern: {
+                        type: string;
+                        description: string;
+                    };
+                    collectionId: {
+                        type: string;
+                        description: string;
+                    };
+                    cascadeDelete: {
+                        type: string;
+                        description: string;
+                    };
+                    maxSelect: {
+                        type: string;
+                        description: string;
+                    };
+                    onCreate: {
+                        type: string;
+                        description: string;
+                    };
+                    onUpdate: {
+                        type: string;
+                        description: string;
+                    };
+                    presentable: {
+                        type: string;
+                        description: string;
+                    };
+                    hidden: {
+                        type: string;
+                        description: string;
+                    };
+                    values: {
+                        type: string;
+                        description: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                    id: {
+                        type: string;
+                        description: string;
+                    };
+                };
+                required: string[];
+            };
+        };
+        listRule: {
+            type: string;
+            description: string;
+        };
+        viewRule: {
+            type: string;
+            description: string;
+        };
+        createRule: {
+            type: string;
+            description: string;
+        };
+        updateRule: {
+            type: string;
+            description: string;
+        };
+        deleteRule: {
+            type: string;
+            description: string;
+        };
+        indexes: {
+            type: string;
+            items: {
+                type: string;
+            };
+            description: string;
+        };
+        viewQuery: {
+            type: string;
+            description: string;
+        };
+        passwordAuth: {
+            type: string;
+            description: string;
+            properties: {
+                enabled: {
+                    type: string;
+                };
+                identityFields: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                };
+            };
+        };
+    };
+    required: string[];
+};
+export declare const deleteCollectionSchema: {
+    type: string;
+    properties: {
+        collection: {
+            type: string;
+            description: string;
+        };
+    };
+    required: string[];
+};
+export declare const getCollectionSchemaSchema: {
+    type: string;
+    properties: {
+        collection: {
+            type: string;
+            description: string;
+        };
+    };
+    required: string[];
+};
+export declare const listCollectionsSchema: {
+    type: string;
+    properties: {
+        sort: {
+            type: string;
+            description: string;
+            default: string;
+        };
+    };
+    required: never[];
+};
+export declare const truncateCollectionSchema: {
+    type: string;
+    properties: {
+        collection: {
+            type: string;
+            description: string;
+        };
+    };
+    required: string[];
+};

package/build/src/tools/schemas/collection.js

@@ -0,0 +1,194 @@
+/**
+ * Tool input schemas for collection-related operations
+ */
+export const createCollectionSchema = {
+    type: "object",
+    properties: {
+        name: {
+            type: "string",
+            description: "Collection name",
+        },
+        type: {
+            type: "string",
+            description: "Collection type (base, auth, view)",
+            enum: ["base", "auth", "view"],
+            default: "base",
+        },
+        fields: {
+            type: "array",
+            description: "Collection fields configuration",
+            items: {
+                type: "object",
+                properties: {
+                    name: { type: "string", description: "Field name" },
+                    type: {
+                        type: "string",
+                        description: "Field type",
+                        enum: [
+                            "text",
+                            "number",
+                            "bool",
+                            "email",
+                            "url",
+                            "date",
+                            "select",
+                            "relation",
+                            "file",
+                            "json",
+                            "editor",
+                            "autodate",
+                        ],
+                    },
+                    required: {
+                        type: "boolean",
+                        description: "Whether the field is required",
+                    },
+                    system: {
+                        type: "boolean",
+                        description: "Whether this is a system field",
+                    },
+                    unique: {
+                        type: "boolean",
+                        description: "Whether the field should have unique values",
+                    },
+                    min: {
+                        type: "number",
+                        description: "Minimum text length or numeric value",
+                    },
+                    max: {
+                        type: "number",
+                        description: "Maximum text length or numeric value",
+                    },
+                    pattern: {
+                        type: "string",
+                        description: "Validation regex pattern for text fields",
+                    },
+                    autogeneratePattern: {
+                        type: "string",
+                        description: "Pattern for autogenerating field values (for text fields)",
+                    },
+                    collectionId: {
+                        type: "string",
+                        description: "Target collection ID for relation fields",
+                    },
+                    cascadeDelete: {
+                        type: "boolean",
+                        description: "Whether to delete related records when the parent is deleted",
+                    },
+                    maxSelect: {
+                        type: "number",
+                        description: "Maximum number of relations or select options (1 for single relation, > 1 for multiple)",
+                    },
+                    onCreate: {
+                        type: "boolean",
+                        description: "Whether to set date on record creation (for autodate fields)",
+                    },
+                    onUpdate: {
+                        type: "boolean",
+                        description: "Whether to update date on record update (for autodate fields)",
+                    },
+                    presentable: {
+                        type: "boolean",
+                        description: "Whether the field can be used as a presentable field in the UI",
+                    },
+                    hidden: {
+                        type: "boolean",
+                        description: "Whether the field is hidden in the UI",
+                    },
+                    values: {
+                        type: "array",
+                        description: "Predefined values for select fields (direct property)",
+                        items: { type: "string" },
+                    },
+                    id: {
+                        type: "string",
+                        description: "Unique identifier for the field",
+                    },
+                },
+                required: ["name", "type"],
+            },
+        },
+        listRule: {
+            type: "string",
+            description: "Rule for listing records",
+        },
+        viewRule: {
+            type: "string",
+            description: "Rule for viewing records",
+        },
+        createRule: {
+            type: "string",
+            description: "Rule for creating records",
+        },
+        updateRule: {
+            type: "string",
+            description: "Rule for updating records",
+        },
+        deleteRule: {
+            type: "string",
+            description: "Rule for deleting records",
+        },
+        indexes: {
+            type: "array",
+            items: { type: "string" },
+            description: "Collection indexes",
+        },
+        viewQuery: {
+            type: "string",
+            description: "SQL query for view collections",
+        },
+        passwordAuth: {
+            type: "object",
+            description: "Password authentication settings for auth collections",
+            properties: {
+                enabled: { type: "boolean" },
+                identityFields: {
+                    type: "array",
+                    items: { type: "string" },
+                },
+            },
+        },
+    },
+    required: ["name", "fields"],
+};
+export const deleteCollectionSchema = {
+    type: "object",
+    properties: {
+        collection: {
+            type: "string",
+            description: "Collection name or ID to delete",
+        },
+    },
+    required: ["collection"],
+};
+export const getCollectionSchemaSchema = {
+    type: "object",
+    properties: {
+        collection: {
+            type: "string",
+            description: "Collection name",
+        },
+    },
+    required: ["collection"],
+};
+export const listCollectionsSchema = {
+    type: "object",
+    properties: {
+        sort: {
+            type: "string",
+            description: "Sort order for collections (e.g., '-created', 'name')",
+            default: "-created",
+        },
+    },
+    required: [],
+};
+export const truncateCollectionSchema = {
+    type: "object",
+    properties: {
+        collection: {
+            type: "string",
+            description: "Collection name or ID to truncate (delete all records)",
+        },
+    },
+    required: ["collection"],
+};

package/build/src/tools/schemas/file.d.ts

@@ -0,0 +1,70 @@
+export declare const uploadFileSchema: {
+    type: "object";
+    properties: {
+        collection: {
+            type: "string";
+            description: string;
+        };
+        recordId: {
+            type: "string";
+            description: string;
+        };
+        fileField: {
+            type: "string";
+            description: string;
+        };
+        fileContent: {
+            type: "string";
+            description: string;
+        };
+        fileName: {
+            type: "string";
+            description: string;
+        };
+    };
+    required: ("collection" | "recordId" | "fileField" | "fileContent" | "fileName")[];
+};
+export declare const downloadFileSchema: {
+    type: "object";
+    properties: {
+        collection: {
+            type: "string";
+            description: string;
+        };
+        recordId: {
+            type: "string";
+            description: string;
+        };
+        fileField: {
+            type: "string";
+            description: string;
+        };
+    };
+    required: ("collection" | "recordId" | "fileField")[];
+};
+export declare const uploadFileFromUrlSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly collection: {
+            readonly type: "string";
+            readonly description: "The name or ID of the collection";
+        };
+        readonly recordId: {
+            readonly type: "string";
+            readonly description: "The ID of the record to attach the file to";
+        };
+        readonly fileField: {
+            readonly type: "string";
+            readonly description: "The name of the file field in the collection schema";
+        };
+        readonly url: {
+            readonly type: "string";
+            readonly description: "The URL to download the file from";
+        };
+        readonly fileName: {
+            readonly type: "string";
+            readonly description: "Optional custom name for the uploaded file. If not provided, will extract from URL";
+        };
+    };
+    readonly required: readonly ["collection", "recordId", "fileField", "url"];
+};

package/build/src/tools/schemas/file.js

@@ -0,0 +1,70 @@
+export const uploadFileSchema = {
+    type: "object",
+    properties: {
+        collection: {
+            type: "string",
+            description: "The name or ID of the collection"
+        },
+        recordId: {
+            type: "string",
+            description: "The ID of the record to attach the file to"
+        },
+        fileField: {
+            type: "string",
+            description: "The name of the file field in the collection schema"
+        },
+        fileContent: {
+            type: "string",
+            description: "The raw content of the file as a string"
+        },
+        fileName: {
+            type: "string",
+            description: "The desired name for the uploaded file (e.g., 'report.txt')"
+        }
+    },
+    required: ["collection", "recordId", "fileField", "fileContent", "fileName"]
+};
+export const downloadFileSchema = {
+    type: "object",
+    properties: {
+        collection: {
+            type: "string",
+            description: "The name or ID of the collection"
+        },
+        recordId: {
+            type: "string",
+            description: "The ID of the record containing the file"
+        },
+        fileField: {
+            type: "string",
+            description: "The name of the file field"
+        }
+    },
+    required: ["collection", "recordId", "fileField"]
+};
+export const uploadFileFromUrlSchema = {
+    type: 'object',
+    properties: {
+        collection: {
+            type: 'string',
+            description: 'The name or ID of the collection'
+        },
+        recordId: {
+            type: 'string',
+            description: 'The ID of the record to attach the file to'
+        },
+        fileField: {
+            type: 'string',
+            description: 'The name of the file field in the collection schema'
+        },
+        url: {
+            type: 'string',
+            description: 'The URL to download the file from'
+        },
+        fileName: {
+            type: 'string',
+            description: 'Optional custom name for the uploaded file. If not provided, will extract from URL'
+        }
+    },
+    required: ['collection', 'recordId', 'fileField', 'url']
+};

package/build/src/tools/schemas/generation.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Tool input schemas for code generation operations
+ */
+export declare const generatePbSchemaSchema: {
+    type: string;
+    properties: {
+        sourceCode: {
+            type: string;
+            description: string;
+        };
+        options: {
+            type: string;
+            description: string;
+            properties: {
+                includeAuthentication: {
+                    type: string;
+                    description: string;
+                };
+                includeTimestamps: {
+                    type: string;
+                    description: string;
+                };
+            };
+        };
+    };
+    required: string[];
+};
+export declare const generateTypescriptInterfacesSchema: {
+    type: string;
+    properties: {
+        collections: {
+            type: string;
+            description: string;
+            items: {
+                type: string;
+            };
+        };
+        options: {
+            type: string;
+            description: string;
+            properties: {
+                includeRelations: {
+                    type: string;
+                    description: string;
+                };
+            };
+        };
+    };
+};

package/build/src/tools/schemas/generation.js

@@ -0,0 +1,49 @@
+/**
+ * Tool input schemas for code generation operations
+ */
+export const generatePbSchemaSchema = {
+    type: "object",
+    properties: {
+        sourceCode: {
+            type: "string",
+            description: "TypeScript interface or database diagram to convert to PocketBase schema",
+        },
+        options: {
+            type: "object",
+            description: "Generation options",
+            properties: {
+                includeAuthentication: {
+                    type: "boolean",
+                    description: "Whether to include authentication related collections",
+                },
+                includeTimestamps: {
+                    type: "boolean",
+                    description: "Whether to include created/updated timestamps",
+                },
+            },
+        },
+    },
+    required: ["sourceCode"],
+};
+export const generateTypescriptInterfacesSchema = {
+    type: "object",
+    properties: {
+        collections: {
+            type: "array",
+            description: "Collection names to generate interfaces for (empty for all)",
+            items: {
+                type: "string",
+            },
+        },
+        options: {
+            type: "object",
+            description: "Generation options",
+            properties: {
+                includeRelations: {
+                    type: "boolean",
+                    description: "Whether to include relation types",
+                },
+            },
+        },
+    },
+};

package/build/src/tools/schemas/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Tool schema registry - exports all tool input schemas
+ */
+export { createCollectionSchema, deleteCollectionSchema, getCollectionSchemaSchema, listCollectionsSchema, truncateCollectionSchema, } from "./collection.js";
+export { createRecordSchema, listRecordsSchema, updateRecordSchema, deleteRecordSchema, } from "./record.js";
+export { authenticateUserSchema, createUserSchema, } from "./auth.js";
+export { analyzeCollectionDataSchema, queryCollectionSchema, } from "./analysis.js";
+export { migrateCollectionSchema, backupDatabaseSchema, importDataSchema, manageIndexesSchema, } from "./migration.js";
+export { generatePbSchemaSchema, generateTypescriptInterfacesSchema, } from "./generation.js";
+export { uploadFileSchema, downloadFileSchema, uploadFileFromUrlSchema, } from "./file.js";

package/build/src/tools/schemas/index.js

@@ -0,0 +1,17 @@
+/**
+ * Tool schema registry - exports all tool input schemas
+ */
+// Collection schemas
+export { createCollectionSchema, deleteCollectionSchema, getCollectionSchemaSchema, listCollectionsSchema, truncateCollectionSchema, } from "./collection.js";
+// Record schemas
+export { createRecordSchema, listRecordsSchema, updateRecordSchema, deleteRecordSchema, } from "./record.js";
+// Auth schemas
+export { authenticateUserSchema, createUserSchema, } from "./auth.js";
+// Analysis schemas
+export { analyzeCollectionDataSchema, queryCollectionSchema, } from "./analysis.js";
+// Migration schemas
+export { migrateCollectionSchema, backupDatabaseSchema, importDataSchema, manageIndexesSchema, } from "./migration.js";
+// Generation schemas
+export { generatePbSchemaSchema, generateTypescriptInterfacesSchema, } from "./generation.js";
+// File schemas
+export { uploadFileSchema, downloadFileSchema, uploadFileFromUrlSchema, } from "./file.js";