@gsb-core/mcp-docs/src/docs/getWorkflowInstanceStatus.ts

Documentation for GSB MCP implementations

/**
 * Documentation for the getWorkflowInstanceStatus operation
 */

/**
 * Returns documentation for the getWorkflowInstanceStatus operation
 * @return {string} markdown documentation
 */
export function getWorkflowInstanceStatusDocs(): string {
  return `
# GetWorkflowInstanceStatus Operation

## General Description

The \`getWorkflowInstanceStatus\` operation retrieves the current status of a workflow instance.

## Detailed Description

This documentation is a placeholder. The getWorkflowInstanceStatus operation details will be updated in a future release.

## Input Parameters

This section will be updated with the correct parameters in a future release.

## Response

This section will be updated with the correct response format in a future release.

## Example Usage

This section will be updated with examples in a future release.

## Additional Information

This section will be updated with additional information in a future release.
`;
}

/**
 * Returns a brief summary of the getWorkflowInstanceStatus operation.
 * @return {string} A short description of the function.
 */
export function getWorkflowInstanceStatusSummary(): string {
  return `
**Purpose**: Checks current execution status of a workflow instance.

**When to use**:
- Monitoring workflow progress
- Determining if workflow is pending/running/completed/failed

**Note**: Placeholder - full documentation coming in future release.
`;
}

export default getWorkflowInstanceStatusDocs;