lokalise-mcp
Version:
The Lokalise MCP Server brings Lokalise's localization power to Claude and AI assistants—manage projects, keys, and translations by chat.
53 lines (52 loc) • 2.57 kB
TypeScript
import type { PaginatedResult, Task, TaskDeleted } from "@lokalise/node-api";
/**
* @namespace TasksFormatter
* @description Utility functions for formatting Lokalise Tasks API responses into readable formats.
* Provides consistent Markdown formatting for various task operations.
*/
/**
* @function formatTasksList
* @description Formats a list of tasks into a comprehensive, LLM-friendly Markdown report
* @memberof TasksFormatter
* @param {PaginatedResult<Task>} response - The raw response from the Lokalise Tasks API list operation
* @param {string} projectId - The project ID for context
* @returns {string} Formatted Markdown string containing the tasks list
*/
export declare function formatTasksList(response: PaginatedResult<Task>, projectId: string): string;
/**
* @function formatTaskDetails
* @description Formats detailed information about a single task with comprehensive LLM-friendly output
* @memberof TasksFormatter
* @param {Task} task - The task object from Lokalise API
* @param {string} projectId - The project ID for context
* @returns {string} Formatted Markdown string containing the task details
*/
export declare function formatTaskDetails(task: Task, projectId: string): string;
/**
* @function formatCreateTaskResult
* @description Formats the result of creating a task
* @memberof TasksFormatter
* @param {Task} task - The created task object from Lokalise API
* @param {string} projectId - The project ID for context
* @returns {string} Formatted Markdown string containing the creation results
*/
export declare function formatCreateTaskResult(task: Task, projectId: string): string;
/**
* @function formatUpdateTaskResult
* @description Formats the result of updating a task
* @memberof TasksFormatter
* @param {Task} task - The updated task object from Lokalise API
* @param {string} projectId - The project ID for context
* @returns {string} Formatted Markdown string containing the update results
*/
export declare function formatUpdateTaskResult(task: Task, projectId: string): string;
/**
* @function formatDeleteTaskResult
* @description Formats the result of deleting a task
* @memberof TasksFormatter
* @param {TaskDeleted} result - The deletion result from Lokalise API
* @param {string} projectId - The project ID for context
* @param {number} taskId - The ID of the deleted task
* @returns {string} Formatted Markdown string containing the deletion confirmation
*/
export declare function formatDeleteTaskResult(result: TaskDeleted, projectId: string, taskId: number): string;