mcp-quickbase
Version:
Work with Quickbase via Model Context Protocol
105 lines (104 loc) • 2.48 kB
TypeScript
import { BaseTool } from "../base";
import { QuickbaseClient } from "../../client/quickbase";
import { FieldProperties } from "./create_field";
/**
* Parameters for update_field tool
*/
export interface UpdateFieldParams {
/**
* The ID of the table containing the field
*/
table_id: string;
/**
* The ID of the field to update
*/
field_id: string;
/**
* New display label for the field
*/
name?: string;
/**
* Help text shown to users when editing the field (stored as fieldHelp)
*/
description?: string;
/**
* Additional options and properties to update
*/
options?: FieldProperties;
}
/**
* Response from updating a field
*/
export interface UpdateFieldResult {
/**
* The ID of the updated field
*/
fieldId: string;
/**
* The updated label/name of the field
*/
label?: string;
/**
* The updated type of the field
*/
fieldType?: string;
/**
* Help text for the field (shown to users when editing)
*/
fieldHelp?: string;
/**
* The ID of the table containing the field
*/
tableId: string;
/**
* Additional details about the updated field
*/
[key: string]: any;
}
/**
* Tool for updating an existing field in a Quickbase table
*/
export declare class UpdateFieldTool extends BaseTool<UpdateFieldParams, UpdateFieldResult> {
name: string;
description: string;
/**
* Parameter schema for update_field
*/
paramSchema: {
type: string;
properties: {
table_id: {
type: string;
description: string;
};
field_id: {
type: string;
description: string;
};
name: {
type: string;
description: string;
};
description: {
type: string;
description: string;
};
options: {
type: string;
description: string;
};
};
required: string[];
};
/**
* Constructor
* @param client Quickbase client
*/
constructor(client: QuickbaseClient);
/**
* Run the update_field tool
* @param params Tool parameters
* @returns Updated field details
*/
protected run(params: UpdateFieldParams): Promise<UpdateFieldResult>;
}