mcp-quickbase
Version:
Work with Quickbase via Model Context Protocol
80 lines (79 loc) • 1.93 kB
TypeScript
import { BaseTool } from "../base";
import { QuickbaseClient } from "../../client/quickbase";
/**
* Parameters for delete_field tool
*/
export interface DeleteFieldParams {
/**
* The ID of the table containing the field
*/
table_id: string;
/**
* The ID of the field to delete
*/
field_id: string;
/**
* Optional explicit confirmation for deletion
*/
confirm_deletion?: boolean;
}
/**
* Response from deleting a field
*/
export interface DeleteFieldResult {
/**
* The ID of the deleted field
*/
deletedFieldId: string;
/**
* The ID of the table the field was deleted from
*/
tableId: string;
/**
* Confirmation message
*/
message: string;
}
/**
* Tool for deleting a field from a Quickbase table.
*
* WARNING: This operation is destructive and cannot be undone.
* All data stored in the field will be permanently lost.
* System fields (IDs 1-5) cannot be deleted.
*/
export declare class DeleteFieldTool extends BaseTool<DeleteFieldParams, DeleteFieldResult> {
name: string;
description: string;
/**
* Parameter schema for delete_field
*/
paramSchema: {
type: string;
properties: {
table_id: {
type: string;
description: string;
};
field_id: {
type: string;
description: string;
};
confirm_deletion: {
type: string;
description: string;
};
};
required: string[];
};
/**
* Constructor
* @param client Quickbase client
*/
constructor(client: QuickbaseClient);
/**
* Run the delete_field tool
* @param params Tool parameters
* @returns Deletion confirmation
*/
protected run(params: DeleteFieldParams): Promise<DeleteFieldResult>;
}