Interfaces

ResolvedToolLimits

Resolved tool limits interface

Properties:

Property	Type	Required
`listDefaultLimit`	`number`	Yes
`listMaxLimit`	`number`	Yes
`maxResponseBytes`	`number`	Yes

TaskPreparationResult

Task preparation result

Properties:

Property	Type	Required
`taskId`	`string`	Yes
`taskTitle`	`string`	Yes
`taskDescription`	`string \| undefined`	No
`projectId`	`string`	Yes

CreateApprovalData

Data required to create a new approval

Properties:

Property	Type	Required
`projectId`	`string`	Yes
`title`	`string`	Yes
`type`	`"document" \| "action"`	Yes
`category`	`"spec" \| "steering"`	Yes
`categoryName`	`string`	Yes
`documentType`	`"tasks" \| "requirements" \| "design" \| "product" \| "tech" \| "structure" \| undefined`	No
`documentContent`	`string \| undefined`	No
`milestoneId`	`string \| undefined`	No
`orgId`	`string`	Yes
`workspaceId`	`string \| undefined`	No
`userId`	`string`	Yes

ApprovalFilters

Filters for listing approvals

Properties:

Property	Type	Required	Description
`status`	`"pending" \| "approved" \| "rejected" \| "needs-revision" \| undefined`	No	Filter by approval status
`projectId`	`string \| undefined`	No	Filter by project ID
`orgId`	`string \| undefined`	No	Filter by organization ID

CreateSteeringData

Data required to create a new steering document

Properties:

Property	Type	Required
`documentType`	`SteeringType`	Yes
`title`	`string`	Yes
`content`	`string`	Yes
`orgId`	`string`	Yes
`projectId`	`string \| undefined`	No
`userId`	`string`	Yes
`templateVersion`	`string \| undefined`	No

ListSteeringDocsOptions

Options for listing steering documents

Properties:

Property	Type	Required	Description
`scope`	`"org" \| "project"`	Yes
`projectId`	`string \| undefined`	No

CreateTemplateData

Data required to create a new template

Properties:

Property	Type	Required
`templateType`	`TemplateType`	Yes
`name`	`string`	Yes
`content`	`string`	Yes
`version`	`string`	Yes
`orgId`	`string`	Yes
`workspaceId`	`string \| undefined`	No
`userId`	`string`	Yes
`metadata`	`{ description: string; language: string; category: "spec" \| "steering"; }`	Yes

TextContent

MCP Tool Response - Text Content

Properties:

Property	Type	Required	Description
`type`	`"text"`	Yes
`text`	`string`	Yes

CallToolResult

MCP Tool Response - Call Tool Result

Properties:

Property	Type	Required	Description
`content`	`TextContent[]`	Yes
`isError`	`boolean`	Yes

AgentAssignment

Agent assignment data

Properties:

Property	Type	Required
`taskId`	`string`	Yes
`agentId`	`string`	Yes
`agentType`	`"main" \| "subagent" \| "reviewer" \| "specialist"`	Yes
`assignedAt`	`string`	Yes
`status`	`"assigned" \| "working" \| "paused" \| "completed"`	Yes
`progress`	`number \| undefined`	No
`notes`	`string \| undefined`	No

AgentWorkload

Agent workload data

Properties:

Property	Type	Required
`agentId`	`string`	Yes
`assigned`	`number`	Yes
`working`	`number`	Yes
`completed`	`number`	Yes
`paused`	`number`	Yes
`tasks`	`{ taskId: string; title: string; status: string; assignedAt: string; }[]`	Yes

TextContent

MCP Tool Response - Text Content

Properties:

Property	Type	Required	Description
`type`	`"text"`	Yes
`text`	`string`	Yes

CallToolResult

MCP Tool Response - Call Tool Result

Properties:

Property	Type	Required	Description
`content`	`TextContent[]`	Yes
`isError`	`boolean`	Yes

TextContent

MCP Tool Response - Text Content

Properties:

Property	Type	Required	Description
`type`	`"text"`	Yes
`text`	`string`	Yes

CallToolResult

MCP Tool Response - Call Tool Result

Properties:

Property	Type	Required	Description
`content`	`TextContent[]`	Yes
`isError`	`boolean`	Yes

TaskDependency

Task dependency data

Properties:

Property	Type	Required
`taskId`	`string`	Yes
`dependsOn`	`string[]`	Yes
`blockedBy`	`string[] \| undefined`	No
`blocking`	`string[] \| undefined`	No

SetDependencyResult

Set dependency result

Properties:

Property	Type	Required
`success`	`boolean`	Yes
`taskId`	`string`	Yes
`dependsOn`	`string[]`	Yes
`message`	`string`	Yes

CanStartResult

Check can start result

Properties:

Property	Type	Required
`canStart`	`boolean`	Yes
`taskId`	`string`	Yes
`message`	`string`	Yes
`blockedBy`	`string[] \| undefined`	No
`missingDependencies`	`{ id: string; title: string; status: string; }[] \| undefined`	No

BlockedTasksResult

Blocked tasks result

Properties:

Property	Type	Required
`success`	`boolean`	Yes
`count`	`number`	Yes
`blockedTasks`	`{ taskId: string; title: string; blockedBy: string[]; waitingFor: Array<{ id: string; title: string; status: string; }>; }[]`	Yes

TextContent

Text content block for MCP responses

Properties:

Property	Type	Required	Description
`type`	`"text"`	Yes
`text`	`string`	Yes

CallToolResult

Result from MCP tool call

Properties:

Property	Type	Required	Description
`content`	`TextContent[]`	Yes
`isError`	`boolean`	Yes

DocumentToolsConfig

Configuration for DocumentTools

Note: workspaceId, orgId, and userId may be undefined if the MCP server is started without proper authentication context. In this case, document operations that require these values will fail with descriptive errors.

Properties:

Property	Type	Required	Description
`client`	`IRxDBClient`	Yes	RxDB client for document operations
`documentStoreUrl`	`string`	Yes	URL of the document-store service
`authToken`	`string`	Yes	Authentication token for API calls
`domainId`	`string`	Yes	Domain ID for multi-tenant isolation
`workspaceId`	`string \| undefined`	No	Workspace ID for document scoping (may be undefined)
`orgId`	`string \| undefined`	No	Organization ID (may be undefined)
`userId`	`string \| undefined`	No	User ID for document ownership (may be undefined)
`ragClient`	`RAGClient \| undefined`	No	Optional RAG client for semantic search

TextContent

MCP Tool Response - Text Content

Properties:

Property	Type	Required	Description
`type`	`"text"`	Yes
`text`	`string`	Yes

ResourceContent

MCP Tool Response - Resource Content

Properties:

Property	Type	Required	Description
`type`	`"resource"`	Yes
`resource`	`{ uri: string; name: string; mimeType: string; text: string; }`	Yes

CallToolResult

MCP Tool Response - Call Tool Result

Properties:

Property	Type	Required	Description
`content`	`(TextContent \| ResourceContent)[]`	Yes
`isError`	`boolean`	Yes

TextContent

MCP Tool Response - Text Content

Properties:

Property	Type	Required	Description
`type`	`"text"`	Yes
`text`	`string`	Yes

CallToolResult

MCP Tool Response - Call Tool Result

Properties:

Property	Type	Required	Description
`content`	`TextContent[]`	Yes
`isError`	`boolean`	Yes

ProjectInitConfig

Project initialization configuration

Properties:

Property	Type	Required
`projectName`	`string`	Yes
`projectType`	`"nodejs" \| "mcp" \| "fullstack" \| "generic"`	Yes
`description`	`string \| undefined`	No
`workspaceId`	`string \| undefined`	No
`workspaceName`	`string \| undefined`	No
`workspaceDescription`	`string \| undefined`	No
`repositoryUrl`	`string \| undefined`	No
`repositoryProvider`	`"github" \| "gitlab" \| "bitbucket" \| "other" \| undefined`	No
`repositoryBranch`	`string \| undefined`	No
`repositoryPrivate`	`boolean \| undefined`	No
`packageManager`	`"npm" \| "yarn" \| "pnpm" \| "bun" \| undefined`	No
`nodeVersion`	`string \| undefined`	No
`projectPath`	`string`	Yes
`userId`	`string`	Yes
`orgId`	`string`	Yes

RAGClientConfig

RAG Client configuration from environment variables

Properties:

Property	Type	Required
`surrealdbUrl`	`string`	Yes
`surrealdbUser`	`string`	Yes
`surrealdbPass`	`string`	Yes
`surrealdbNamespace`	`string`	Yes
`surrealdbDatabase`	`string`	Yes
`ollamaUrl`	`string`	Yes
`embeddingModel`	`string`	Yes

TextContent

MCP Tool Response - Text Content

Properties:

Property	Type	Required	Description
`type`	`"text"`	Yes
`text`	`string`	Yes

CallToolResult

MCP Tool Response - Call Tool Result

Properties:

Property	Type	Required	Description
`content`	`TextContent[]`	Yes
`isError`	`boolean`	Yes

SessionContext

Session context data

Properties:

Property	Type	Required
`sessionId`	`string`	Yes
`codebaseId`	`string`	Yes
`workspaceId`	`string`	Yes
`projectId`	`string \| undefined`	No
`userId`	`string`	Yes
`orgId`	`string`	Yes
`context`	`{ [key: string]: any; activeTaskId?: string; currentPhase?: string; lastActivity?: string; workingDirectory?: string; gitBranch?: string; notes?: string; }`	Yes
`createdAt`	`string`	Yes
`updatedAt`	`string`	Yes
`expiresAt`	`string \| undefined`	No

TaskExecutionResult

Task execution result

Properties:

Property	Type	Required
`taskId`	`string`	Yes
`executionType`	`"local" \| "remote"`	Yes
`assignedAgent`	`string \| undefined`	No
`message`	`string`	Yes

TextContent

MCP Tool Response - Text Content

Properties:

Property	Type	Required	Description
`type`	`"text"`	Yes
`text`	`string`	Yes

CallToolResult

MCP Tool Response - Call Tool Result

Properties:

Property	Type	Required
`content`	`TextContent[]`	Yes
`isError`	`boolean`	Yes
`dashboardUrl`	`string \| undefined`	No
`dashboardAvailable`	`boolean \| undefined`	No

WorkflowGuideResult

Workflow guide response with dashboard info

Properties:

Property	Type	Required	Description
`dashboardUrl`	`string`	Yes
`dashboardAvailable`	`boolean`	Yes

TextContent

MCP Tool Response - Text Content

Properties:

Property	Type	Required	Description
`type`	`"text"`	Yes
`text`	`string`	Yes

CallToolResult

MCP Tool Response - Call Tool Result

Properties:

Property	Type	Required	Description
`content`	`TextContent[]`	Yes
`isError`	`boolean`	Yes

EnvironmentConfig

Environment-specific configuration

Properties:

Property	Type	Required	Description
`serverUrl`	`string`	Yes	Server URL for this environment
`domainId`	`string`	Yes	Domain ID for this environment
`replicationServerUrl`	`string \| undefined`	No	Optional replication server URL (if different from main server)
`authToken`	`string \| undefined`	No	Optional authentication token

ServerConfig

Server configuration with multiple environments

Properties:

Property	Type	Required	Description
`id`	`string`	Yes	Unique server identifier
`name`	`string`	Yes	Human-readable server name
`environments`	`Record<Environment, EnvironmentConfig>`	Yes	Environment configurations
`activeEnvironment`	`Environment`	Yes	Currently active environment
`replicationEnabled`	`boolean \| undefined`	No	Whether replication is enabled
`metadata`	`Record<string, any> \| undefined`	No	Additional metadata

StoredServerConfig

Stored server configuration with authentication

Properties:

Property	Type	Required	Description
`authTokens`	`Partial<Record<Environment, string>> \| undefined`	No	Stored authentication tokens per environment
`lastConnected`	`string \| undefined`	No	Last connection timestamp
`isDefault`	`boolean \| undefined`	No	Whether this is the default server

ServerConfigStore

Server configuration store

Properties:

Property	Type	Required	Description
`servers`	`Record<string, StoredServerConfig>`	Yes	Map of server ID to server config
`activeServerId`	`string \| undefined`	No	Currently active server ID
`version`	`string`	Yes	Version of config format

CLISettings

CLI-specific settings

Properties:

Property	Type	Required	Description
`defaultEditor`	`string`	Yes	Default editor for editing files
`colorOutput`	`boolean`	Yes	Whether to use color output in terminal
`verboseLogging`	`boolean`	Yes	Enable verbose logging
`outputFormat`	`"json" \| "table" \| "yaml" \| undefined`	No	Default output format (json, table, etc.)

AgentSettings

Agent-specific settings

Properties:

Property	Type	Required	Description
`defaultPollInterval`	`number`	Yes	Default polling interval in milliseconds
`maxConcurrentTasks`	`number`	Yes	Maximum concurrent tasks per agent
`defaultLogLevel`	`"debug" \| "info" \| "warn" \| "error"`	Yes	Default log level for agents
`autoRestart`	`boolean \| undefined`	No	Auto-restart agents on failure

AgentConfig

Agent runtime configuration

Properties:

Property	Type	Required
`id`	`string`	Yes
`name`	`string`	Yes
`status`	`"error" \| "running" \| "stopped"`	Yes
`startedAt`	`string \| undefined`	No
`stoppedAt`	`string \| undefined`	No
`tasksCompleted`	`number \| undefined`	No
`tasksInProgress`	`number \| undefined`	No
`lastError`	`string \| undefined`	No

FlowStateConfig

Complete FlowState CLI configuration Stored in ~/.flowstate/config.json

Properties:

Property	Type	Required	Description
`version`	`string`	Yes	Configuration format version
`servers`	`ServerConfigStore`	Yes	Server configurations
`cli`	`CLISettings`	Yes	CLI settings
`agent`	`AgentSettings`	Yes	Agent settings
`lastUpdated`	`string \| undefined`	No	Last updated timestamp

IRxDBClient

Common interface for database clients (RxDBClientManager and RxDBRestClient) This allows tools and managers to work with either local or REST clients

Properties:

Property	Type	Required
`projects`	`{ insert(doc: ProjectModel): Promise<any>; findOne(params: { selector: any; }): { exec(): Promise<ProjectModel \| null>; }; find(params: { selector: any; sort?: any; }): { exec(): Promise<ProjectModel[]>; }; }`	Yes
`milestones`	`{ insert(doc: MilestoneModel): Promise<any>; bulkInsert?(docs: MilestoneModel[]): Promise<any>; update(id: string, updates: Partial<MilestoneModel>): Promise<MilestoneModel>; findOne(params: { selector: any; }): { exec(): Promise<any>; }; find(params: { selector: any; sort?: any; }): { exec(): Promise<MilestoneModel[]>; }; }`	Yes
`tasks`	`{ insert(doc: TaskModel): Promise<any>; bulkInsert?(docs: TaskModel[]): Promise<any>; update(id: string, updates: Partial<TaskModel>): Promise<TaskModel>; findOne(params: { selector: any; }): { exec(): Promise<any>; }; find(params: { selector: any; sort?: any; }): { exec(): Promise<TaskModel[]>; }; }`	Yes
`discussions`	`{ insert(doc: DiscussionModel): Promise<any>; find(params: { selector: any; }): { exec(): Promise<DiscussionModel[]>; }; }`	Yes
`logs`	`{ insert(doc: LogModel): Promise<any>; findOne(params: { selector: any; }): { exec(): Promise<LogModel \| null>; }; find(params: { selector: any; sort?: any; limit?: number; }): { exec(): Promise<LogModel[]>; }; }`	Yes
`timeentries`	`{ insert(doc: TimeEntryModel): Promise<any>; find(params: { selector: any; }): { exec(): Promise<TimeEntryModel[]>; }; }`	Yes
`approvals`	`{ insert(doc: ApprovalModel): Promise<any>; update(id: string, updates: Partial<ApprovalModel>): Promise<ApprovalModel>; findOne(params: { selector: any; }): { exec(): Promise<any>; }; find(params: { selector: any; }): { exec(): Promise<ApprovalModel[]>; }; }`	Yes
`templates`	`{ insert(doc: TemplateModel): Promise<any>; update(id: string, updates: Partial<TemplateModel>): Promise<TemplateModel>; findOne(params: { selector: any; }): { exec(): Promise<any>; }; find(params: { selector: any; }): { exec(): Promise<TemplateModel[]>; }; }`	Yes
`steeringdocuments`	`{ insert(doc: DocumentModel): Promise<any>; update(id: string, updates: Partial<DocumentModel>): Promise<DocumentModel>; findOne(params: { selector: any; }): { exec(): Promise<any>; }; find(params: { selector: any; }): { exec(): Promise<DocumentModel[]>; }; }`	Yes
`documents`	`{ insert(doc: DocumentModel): Promise<any>; update(id: string, updates: Partial<DocumentModel>): Promise<DocumentModel>; findOne(params: { selector: any; }): { exec(): Promise<any>; }; find(params: { selector: any; sort?: any; }): { exec(): Promise<DocumentModel[]>; }; }`	Yes
`workspaces`	`{ insert(doc: WorkspaceModel): Promise<any>; update(id: string, updates: Partial<WorkspaceModel>): Promise<WorkspaceModel>; findOne(params: { selector: any; }): { exec(): Promise<any>; }; find(params: { selector: any; sort?: any; }): { exec(): Promise<WorkspaceModel[]>; }; }`	Yes
`codebases`	`{ insert(doc: CodebaseModel): Promise<any>; update(id: string, updates: Partial<CodebaseModel>): Promise<CodebaseModel>; findOne(params: { selector: any; }): { exec(): Promise<any>; }; find(params: { selector: any; sort?: any; }): { exec(): Promise<CodebaseModel[]>; }; }`	Yes
`sessions`	`{ insert(doc: SessionModel): Promise<any>; update(id: string, updates: Partial<SessionModel>): Promise<SessionModel>; findOne(params: { selector: any; }): { exec(): Promise<any>; }; find(params: { selector: any; sort?: any; }): { exec(): Promise<SessionModel[]>; }; }`	Yes

StoredAuthCredentials

Configuration for initializing the MCP server

Properties:

Property	Type	Required	Description
`accessToken`	`string`	Yes	Current access token
`refreshToken`	`string`	Yes	Refresh token for getting new access tokens
`expiresAt`	`number`	Yes	Token expiration timestamp (ms since epoch)
`userId`	`string`	Yes	User ID
`email`	`string`	Yes	User email

MCPServerConfig

Properties:

Property	Type	Required	Description
`projectPath`	`string`	Yes	Absolute path to the project root directory
`rxdbServerUrl`	`string`	Yes	RxDB server URL for replication
`authToken`	`string`	Yes	Authentication token for RxDB server
`domainId`	`string`	Yes	Domain ID for data isolation
`userId`	`string \| undefined`	No	Optional user ID for operations
`orgId`	`string \| undefined`	No	Optional organization ID
`workspaceId`	`string \| undefined`	No	Optional workspace ID (falls back to orgId if not provided)
`databaseName`	`string \| undefined`	No	Optional database name override (mainly for testing)
`storageType`	`"filesystem" \| "memory" \| undefined`	No	Optional storage type (defaults to 'filesystem', use 'memory' for tests)
`authCredentials`	`StoredAuthCredentials \| undefined`	No	Optional full auth credentials for token refresh (when using --profile)
`profileName`	`string \| undefined`	No	Optional server profile name for persisting refreshed tokens

RxDBClientConfig

Configuration for RxDB client connection and replication

Properties:

Property	Type	Required	Description
`serverUrl`	`string`	Yes	RxDB server URL
`authToken`	`string`	Yes	Authentication token
`domainId`	`string`	Yes	Domain ID for data filtering
`collections`	`string[]`	Yes	Collections to initialize and replicate

Available collections:

'projects': Project documents including specs
'milestones': Project phases and milestones
'tasks': Task items with execution metadata
'discussions': Threaded discussions and comments
'logs': System and application logs
'timeentries': Time tracking entries
'approvals': Approval workflow documents
'templates': Document and workflow templates
'steeringdocuments': Steering documents for projects
'sessions': Session context for recovery and handoff | | userId | string \| undefined | No | Optional user ID for document creation | | orgId | string \| undefined | No | Optional organization ID | | databaseName | string \| undefined | No | Optional database name override (mainly for testing) | | storagePath | string \| undefined | No | Optional storage path for filesystem storage (defaults to ~/.flowstate/data) | | storageType | "filesystem" \| "memory" \| undefined | No | Optional storage type (defaults to 'filesystem', use 'memory' for tests) |

WorkerConfig

Configuration for remote worker agents

Properties:

Property	Type	Required	Description
`workerId`	`string`	Yes	Unique worker identifier
`agentName`	`string`	Yes	Human-readable agent name
`serverUrl`	`string`	Yes	RxDB server URL
`authToken`	`string`	Yes	Authentication token
`domainId`	`string`	Yes	Domain ID
`pollInterval`	`number`	Yes	Polling interval in milliseconds
`logLevel`	`"debug" \| "info" \| "warn" \| "error"`	Yes	Minimum log level to capture
`userId`	`string \| undefined`	No	User ID for log attribution
`orgId`	`string \| undefined`	No	Organization ID

SpecCreateArgs

Arguments for spec-create MCP tool

Properties:

Property	Type	Required	Description
`name`	`string`	Yes	Kebab-case spec name
`description`	`string \| undefined`	No	Optional description
`userId`	`string`	Yes	User ID creating the spec
`orgId`	`string`	Yes	Organization ID
`workspaceId`	`string \| undefined`	No	Optional workspace ID to associate spec with
`codebaseId`	`string \| undefined`	No	Optional codebase ID to associate spec with

SpecCreateResult

Result from spec-create MCP tool

Properties:

Property	Type	Required	Description
`success`	`boolean`	Yes	Success flag
`message`	`string \| undefined`	No	Optional message
`projectId`	`string \| undefined`	No	Created project ID
`specName`	`string \| undefined`	No	Spec name
`milestones`	`{ id: string; title: string; phaseType: "requirements" \| "design" \| "tasks" \| "implementation"; }[] \| undefined`	No	Created milestone phases

SpecStatusArgs

Arguments for spec-status MCP tool

Properties:

Property	Type	Required	Description
`name`	`string`	Yes	Spec name to query

SpecProgress

Progress information for a spec

Properties:

Property	Type	Required	Description
`totalTasks`	`number`	Yes	Total number of tasks
`completedTasks`	`number`	Yes	Number of completed tasks
`inProgressTasks`	`number`	Yes	Number of in-progress tasks
`percentComplete`	`number`	Yes	Completion percentage (0-100)

PhaseWorkflowStatus

Phase workflow status

Properties:

Property	Type	Required	Description
`phaseType`	`"tasks" \| "requirements" \| "design" \| "implementation"`	Yes	Phase type
`title`	`string`	Yes	Phase title
`hasContent`	`boolean`	Yes	Whether phase has document content
`approved`	`boolean`	Yes	Whether phase document is approved
`lastUpdated`	`string \| undefined`	No	When document was last updated
`approvedAt`	`string \| undefined`	No	When document was approved
`approvedBy`	`string \| undefined`	No	User ID who approved

SpecWorkflowData

Workflow data for spec status

Properties:

Property	Type	Required	Description
`phases`	`PhaseWorkflowStatus[]`	Yes	Phase-by-phase workflow status

SpecStatusResult

Result from spec-status MCP tool

Properties:

Property	Type	Required	Description
`success`	`boolean`	Yes	Success flag
`message`	`string \| undefined`	No	Optional message
`project`	`ProjectModel \| undefined`	No	Project representing the spec
`milestones`	`MilestoneModel[] \| undefined`	No	Milestone phases
`tasks`	`TaskModel[] \| undefined`	No	All tasks in the spec
`progress`	`SpecProgress \| undefined`	No	Progress summary
`workflow`	`SpecWorkflowData \| undefined`	No	Workflow data including phase approval status (optional for backward compatibility)
`workspace`	`{ id: string; name: string; title: string; } \| null \| undefined`	No	Associated workspace information (null if not associated)
`codebase`	`{ id: string; name: string; title: string; workspaceId: string; } \| null \| undefined`	No	Associated codebase information (null if not associated)

SpecExecuteTaskArgs

Arguments for spec-execute-task MCP tool

Properties:

Property	Type	Required	Description
`specName`	`string`	Yes	Spec name
`taskId`	`string`	Yes	Task ID to execute
`remote`	`boolean \| undefined`	No	If true, queue for remote execution
`assignToAgent`	`string \| undefined`	No	Optional agent to assign to

TaskExecutionContext

Context for task execution

Properties:

Property	Type	Required	Description
`taskId`	`string`	Yes	Task ID being executed
`specName`	`string`	Yes	Spec name
`userId`	`string`	Yes	User ID executing
`orgId`	`string`	Yes	Organization ID
`assignToAgent`	`string \| undefined`	No	Optional: assign via tag (agent:worker-id)

DiscussionLogEntry

Entry for logging to Discussion collection

Properties:

Property	Type	Required	Description
`entityType`	`"system" \| "projects" \| "milestones" \| "tasks"`	Yes	Entity type being logged
`entityId`	`string`	Yes	Entity ID
`content`	`string`	Yes	Log content
`contentHtml`	`string \| undefined`	No	Optional HTML content
`userName`	`string`	Yes	User or agent name
`userId`	`string`	Yes	User or agent ID
`orgId`	`string`	Yes	Organization ID
`parentId`	`string \| undefined`	No	Parent discussion ID for threading
`metadata`	`Record<string, unknown> \| undefined`	No	Additional metadata

ServerConnectionTestResult

Result from testing server connection

Properties:

Property	Type	Required	Description
`success`	`boolean`	Yes	Whether connection succeeded
`serverUrl`	`string`	Yes	Server URL tested
`responseTime`	`number \| undefined`	No	Response time in milliseconds
`error`	`string \| undefined`	No	Error message if failed
`serverVersion`	`string \| undefined`	No	Server version if available

CreateWorkspaceData

Data required to create a new workspace

Properties:

Property	Type	Required	Description
`name`	`string`	Yes	Workspace name (will be sanitized to kebab-case)
`title`	`string`	Yes	Human-readable workspace title
`description`	`string`	Yes	Workspace description
`tags`	`string[] \| undefined`	No	Optional tags for organization
`orgId`	`string`	Yes	Organization ID
`userId`	`string`	Yes	User ID creating the workspace
`metadata`	`{ [key: string]: any; teamMembers?: string[]; primaryLanguage?: "typescript" \| "javascript" \| "python" \| "go" \| "rust" \| "other"; frameworks?: string[]; methodology?: "agile" \| "scrum" \| "kanban" \| "waterfall"; } \| undefined`	No	Optional extensible metadata

CreateWorkspaceResult

Result from creating a workspace

Properties:

Property	Type	Required	Description
`success`	`boolean`	Yes	Success flag
`workspaceId`	`string \| undefined`	No	Created workspace ID
`message`	`string \| undefined`	No	Error or success message

WorkspaceFilters

Filters for listing workspaces

Properties:

Property	Type	Required	Description
`orgId`	`string \| undefined`	No	Filter by organization ID
`status`	`"paused" \| "active" \| "archived" \| undefined`	No	Filter by workspace status
`name`	`string \| undefined`	No	Filter by workspace name

UpdateWorkspaceData

Data for updating a workspace

Properties:

Property	Type	Required	Description
`title`	`string \| undefined`	No	Updated title
`description`	`string \| undefined`	No	Updated description
`tags`	`string[] \| undefined`	No	Updated tags
`status`	`"paused" \| "active" \| "archived" \| undefined`	No	Updated status
`metadata`	`Record<string, any> \| undefined`	No	Updated metadata

UpdateWorkspaceResult

Result from updating a workspace

Properties:

Property	Type	Required	Description
`success`	`boolean`	Yes	Success flag
`message`	`string \| undefined`	No	Error or success message

ArchiveWorkspaceResult

Result from archiving a workspace

Properties:

Property	Type	Required	Description
`success`	`boolean`	Yes	Success flag
`message`	`string \| undefined`	No	Error or success message
`archivedAt`	`string \| undefined`	No	Timestamp when archived

CreateCodebaseData

Data required to create a new codebase

Properties:

Property	Type	Required	Description
`name`	`string`	Yes	Codebase name (will be sanitized to kebab-case)
`title`	`string`	Yes	Human-readable codebase title
`description`	`string`	Yes	Codebase description
`workspaceId`	`string`	Yes	Parent workspace ID
`repository`	`{ url: string; defaultBranch: string; provider: "github" \| "gitlab" \| "bitbucket" \| "other"; organization?: string; repositoryName?: string; privateRepo: boolean; accessToken?: string; sshKey?: string; }`	Yes	Git repository configuration
`environment`	`{ nodeVersion?: string; packageManager: "npm" \| "yarn" \| "pnpm" \| "bun"; workingDirectory?: string; setupCommands: string[]; testCommands?: string[]; buildCommands?: string[]; environmentVariables?: Record<string, string>; }`	Yes	Development environment configuration
`deployment`	`{ platform: "cloudflare" \| "digitalocean" \| "vercel" \| "railway" \| "aws" \| "custom"; productionUrl?: string; stagingUrl?: string; previewUrlPattern?: string; deployCommand?: string; deployBranch?: string; cicdProvider?: "github-actions" \| "gitlab-ci" \| "cloudflare-pages" \| "custom"; cicdConfigPath?: string; platformConfig?: Record<string, any>; } \| undefined`	No	Optional deployment configuration
`agentWorkflow`	`{ branchStrategy: "feature-per-spec" \| "feature-per-task" \| "shared-branch"; branchPrefix: string; commitConvention: "conventional" \| "simple" \| "custom"; commitTemplate?: string; requireTests: boolean; requireLint: boolean; createPR: boolean; prTitleTemplate?: string; prDescriptionTemplate?: string; prReviewers?: string[]; prLabels?: string[]; } \| undefined`	No	Optional agent workflow configuration
`tags`	`string[] \| undefined`	No	Optional tags for organization
`orgId`	`string`	Yes	Organization ID
`userId`	`string`	Yes	User ID creating the codebase
`metadata`	`{ [key: string]: any; monorepo: boolean; languages?: string[]; frameworks?: string[]; testFramework?: string; codeStyle?: string; docsUrl?: string; } \| undefined`	No	Optional extensible metadata

CreateCodebaseResult

Result from creating a codebase

Properties:

Property	Type	Required	Description
`success`	`boolean`	Yes	Success flag
`codebaseId`	`string \| undefined`	No	Created codebase ID
`message`	`string \| undefined`	No	Error or success message

CodebaseFilters

Filters for listing codebases

Properties:

Property	Type	Required	Description
`workspaceId`	`string \| undefined`	No	Filter by workspace ID
`orgId`	`string \| undefined`	No	Filter by organization ID
`status`	`"paused" \| "active" \| "archived" \| undefined`	No	Filter by codebase status
`name`	`string \| undefined`	No	Filter by codebase name

UpdateCodebaseData

Data for updating a codebase

Properties:

Property	Type	Required	Description
`title`	`string \| undefined`	No	Updated title
`description`	`string \| undefined`	No	Updated description
`repository`	`Partial<{ url: string; defaultBranch: string; provider: "github" \| "gitlab" \| "bitbucket" \| "other"; organization?: string; repositoryName?: string; privateRepo: boolean; accessToken?: string; sshKey?: string; }> \| undefined`	No	Partial repository updates
`environment`	`Partial<{ nodeVersion?: string; packageManager: "npm" \| "yarn" \| "pnpm" \| "bun"; workingDirectory?: string; setupCommands: string[]; testCommands?: string[]; buildCommands?: string[]; environmentVariables?: Record<string, string>; }> \| undefined`	No	Partial environment updates
`deployment`	`Partial<{ platform: "cloudflare" \| "digitalocean" \| "vercel" \| "railway" \| "aws" \| "custom"; productionUrl?: string; stagingUrl?: string; previewUrlPattern?: string; deployCommand?: string; deployBranch?: string; cicdProvider?: "github-actions" \| "gitlab-ci" \| "cloudflare-pages" \| "custom"; cicdConfigPath?: string; platformConfig?: Record<string, any>; } \| undefined>`	No	Partial deployment updates
`agentWorkflow`	`Partial<{ branchStrategy: "feature-per-spec" \| "feature-per-task" \| "shared-branch"; branchPrefix: string; commitConvention: "conventional" \| "simple" \| "custom"; commitTemplate?: string; requireTests: boolean; requireLint: boolean; createPR: boolean; prTitleTemplate?: string; prDescriptionTemplate?: string; prReviewers?: string[]; prLabels?: string[]; } \| undefined>`	No	Partial agent workflow updates
`tags`	`string[] \| undefined`	No	Updated tags
`status`	`"paused" \| "active" \| "archived" \| undefined`	No	Updated status
`metadata`	`Record<string, any> \| undefined`	No	Updated metadata

UpdateCodebaseResult

Result from updating a codebase

Properties:

Property	Type	Required	Description
`success`	`boolean`	Yes	Success flag
`message`	`string \| undefined`	No	Error or success message

ArchiveCodebaseResult

Result from archiving a codebase

Properties:

Property	Type	Required	Description
`success`	`boolean`	Yes	Success flag
`message`	`string \| undefined`	No	Error or success message
`archivedAt`	`string \| undefined`	No	Timestamp when archived

ValidationIssue

Validation issue for codebase configuration

Properties:

Property	Type	Required	Description
`field`	`string`	Yes	Field with the issue
`issue`	`string`	Yes	Description of the issue
`severity`	`"error" \| "warning"`	Yes	Severity of the issue

ValidationResult

Result from validating a codebase

Properties:

Property	Type	Required	Description
`success`	`boolean`	Yes	Success flag (operation completed)
`valid`	`boolean`	Yes	Whether codebase configuration is valid
`issues`	`ValidationIssue[]`	Yes	List of validation issues
`message`	`string`	Yes	Summary message

LogModel

Stubbed Log Types

The Log collection has been removed from db-collections. These stubs maintain type compatibility until a new logging system is implemented.

TODO: Replace with new logging system (e.g., observability platform integration)

Properties:

Property	Type	Required
`id`	`string`	Yes
`message`	`string`	Yes
`level`	`string`	Yes
`source`	`string \| undefined`	No
`timestamp`	`string`	Yes
`entityType`	`string \| undefined`	No
`entityId`	`string \| undefined`	No
`category`	`string \| undefined`	No
`metadata`	`Record<string, unknown> \| undefined`	No
`orgId`	`string`	Yes
`userId`	`string \| undefined`	No
`workspaceId`	`string \| undefined`	No
`parentLogId`	`string \| undefined`	No
`trashed`	`boolean \| undefined`	No
`archived`	`boolean \| undefined`	No
`createdAt`	`string \| undefined`	No
`updatedAt`	`string \| undefined`	No

TaskHierarchy

Task hierarchy information

Properties:

Property	Type	Required
`taskNumber`	`string \| null`	Yes
`parentNumber`	`string \| null`	Yes
`level`	`number`	Yes

TaskMetadata

Task metadata information

Properties:

Property	Type	Required
`requirements`	`string \| null`	Yes
`leverage`	`string \| null`	Yes
`prompt`	`string \| null`	Yes

ParsedTask

Parsed task information combining all extraction methods

Properties:

Property	Type	Required
`rawLine`	`string`	Yes
`status`	`MarkdownStatus`	Yes
`taskNumber`	`string \| null`	Yes
`parentNumber`	`string \| null`	Yes
`level`	`number`	Yes
`description`	`string`	Yes
`metadata`	`TaskMetadata`	Yes

TextContent

MCP Tool Response - Text Content

Properties:

Property	Type	Required	Description
`type`	`"text"`	Yes
`text`	`string`	Yes

ResourceContent

MCP Tool Response - Resource Content

Properties:

Property	Type	Required	Description
`type`	`"resource"`	Yes
`resource`	`{ uri: string; name: string; mimeType: string; text: string; }`	Yes

CallToolResult

MCP Tool Response - Call Tool Result

Properties:

Property	Type	Required	Description
`content`	`(TextContent \| ResourceContent)[]`	Yes
`isError`	`boolean`	Yes

TextContent

MCP Tool Response - Text Content

Properties:

Property	Type	Required	Description
`type`	`"text"`	Yes
`text`	`string`	Yes

ResourceContent

MCP Tool Response - Resource Content

Properties:

Property	Type	Required	Description
`type`	`"resource"`	Yes
`resource`	`{ uri: string; name: string; mimeType: string; text: string; }`	Yes

CallToolResult

MCP Tool Response - Call Tool Result

Properties:

Property	Type	Required	Description
`content`	`(TextContent \| ResourceContent)[]`	Yes
`isError`	`boolean`	Yes

TextContent

MCP Tool Response - Text Content

Properties:

Property	Type	Required	Description
`type`	`"text"`	Yes
`text`	`string`	Yes

ResourceContent

MCP Tool Response - Resource Content

Properties:

Property	Type	Required	Description
`type`	`"resource"`	Yes
`resource`	`{ uri: string; name: string; mimeType: string; text: string; }`	Yes

CallToolResult

MCP Tool Response - Call Tool Result

Properties:

Property	Type	Required	Description
`content`	`(TextContent \| ResourceContent)[]`	Yes
`isError`	`boolean`	Yes

TextContent

MCP Tool Response - Text Content

Properties:

Property	Type	Required	Description
`type`	`"text"`	Yes
`text`	`string`	Yes

ResourceContent

MCP Tool Response - Resource Content

Properties:

Property	Type	Required	Description
`type`	`"resource"`	Yes
`resource`	`{ uri: string; name: string; mimeType: string; text: string; }`	Yes

CallToolResult

MCP Tool Response - Call Tool Result

Properties:

Property	Type	Required	Description
`content`	`(TextContent \| ResourceContent)[]`	Yes
`isError`	`boolean`	Yes

TextContent

MCP Tool Response - Text Content

Properties:

Property	Type	Required	Description
`type`	`"text"`	Yes
`text`	`string`	Yes

ResourceContent

MCP Tool Response - Resource Content

Properties:

Property	Type	Required	Description
`type`	`"resource"`	Yes
`resource`	`{ uri: string; name: string; mimeType: string; text: string; }`	Yes

CallToolResult

MCP Tool Response - Call Tool Result

Properties:

Property	Type	Required	Description
`content`	`(TextContent \| ResourceContent)[]`	Yes
`isError`	`boolean`	Yes