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

Documentation for GSB MCP implementations

/**
 * Documentation for the runWorkflow operation
 */

/**
 * Returns documentation for the runWorkflow operation
 * @return {string} markdown documentation
 */
export function runWorkflowDocs(): string {
  return `
# RunWorkflow Operation

## General Description

The \`runWorkflow\` operation executes a workflow synchronously.

## Detailed Description

This documentation is a placeholder. The runWorkflow 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 runWorkflow operation.
 * @return {string} A short description of the function.
 */
export function runWorkflowSummary(): string {
  return `
**Purpose**: Executes a workflow synchronously and waits for completion.

**When to use**:
- Quick workflows without user interaction
- Need immediate results

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

export default runWorkflowDocs;