mcp-quickbase/dist/tools/fields/get_field.d.ts

Work with Quickbase via Model Context Protocol

import { BaseTool } from "../base";
import { QuickbaseClient } from "../../client/quickbase";
/**
 * Parameters for get_field tool
 */
export interface GetFieldParams {
    /**
     * The ID of the table containing the field
     */
    table_id: string;
    /**
     * The ID of the field to retrieve
     */
    field_id: string;
}
/**
 * Response from getting a field
 */
export interface GetFieldResult {
    /**
     * The ID of the field
     */
    fieldId: string;
    /**
     * The label (display name) of the field
     */
    label: string;
    /**
     * The type of the field
     */
    fieldType: string;
    /**
     * The description of the field
     */
    description?: string;
    /**
     * Whether the field is required
     */
    required?: boolean;
    /**
     * Whether the field is unique
     */
    unique?: boolean;
    /**
     * Additional properties of the field
     */
    properties?: Record<string, any>;
    /**
     * The ID of the table containing the field
     */
    tableId: string;
    /**
     * Additional details about the field
     */
    [key: string]: any;
}
/**
 * Tool for retrieving detailed information about a single field by ID
 */
export declare class GetFieldTool extends BaseTool<GetFieldParams, GetFieldResult> {
    name: string;
    description: string;
    /**
     * Parameter schema for get_field
     */
    paramSchema: {
        type: string;
        properties: {
            table_id: {
                type: string;
                description: string;
            };
            field_id: {
                type: string;
                description: string;
            };
        };
        required: string[];
    };
    /**
     * Constructor
     * @param client Quickbase client
     */
    constructor(client: QuickbaseClient);
    /**
     * Run the get_field tool
     * @param params Tool parameters
     * @returns Field information
     */
    protected run(params: GetFieldParams): Promise<GetFieldResult>;
}