Generated from plugin version
0.7.28 in
../../orgx-openclaw-plugin-tool-guidance. Regenerate with pnpm docs:generate-openclaw-plugin.Endpoint Model
Scoped Domains
Tool Catalog
Sync & Reporting
orgx_emit_activity
Emit append-only OrgX activity telemetry (launch reporting contract primary write tool).string
Initiative UUID (required unless ORGX_INITIATIVE_ID is set)
string
required
Human-readable activity update
string
Optional run UUID
string
Required when run_id is omitted
string
Required when run_id is omitted Options:
openclaw, codex, claude-code,
api.string
Reporting phase Options:
intent, execution, blocked, review,
handoff, completed.number
Optional progress percentage
string
Optional level (default info) Options:
info, warn, error.string
Optional next step
object
Optional structured metadata
design, engineering, marketing, operations, orchestration, product, sales
orgx_register_artifact
Register a work output (PR, document, config change, report, etc.) as a work_artifact in OrgX. Makes it visible in the dashboard activity timeline and entity detail modals.string
Convenience: initiative UUID. Used as entity_type=‘initiative’,
entity_id=<this> when entity_type/entity_id are not provided.
string
The type of entity this artifact is attached to Options:
initiative,
milestone, task, decision, project.string
UUID of the entity this artifact is attached to
string
required
Human-readable artifact name (e.g., ‘PR #107: Fix build size’)
string
required
Artifact type code (e.g., ‘eng.diff_pack’, ‘pr’, ‘document’). Falls back to
‘shared.project_handbook’ if the type is not recognized by OrgX.
number
Self-assessed confidence for this artifact in [0,1].
string
What this artifact is and why it matters
string
External link to the artifact (PR URL, file path, etc.)
string
Inline preview content (markdown/text). At least one of url or content is
required.
design, engineering, marketing, operations, orchestration, product, sales
orgx_report_progress
Alias for orgx_emit_activity. Report progress at key milestones so the team can track your work.string
Initiative UUID (required unless ORGX_INITIATIVE_ID is set)
string
Optional run UUID
string
Required when run_id is omitted
string
Options:
openclaw, codex, claude-code, api.string
required
What was accomplished (1-2 sentences, human-readable)
string
required
Current work phase Options:
researching, implementing, testing,
reviewing, blocked.number
Progress percentage (0-100)
string
What you plan to do next
design, engineering, marketing, operations, orchestration, product, sales
orgx_status
Get current OrgX org status: active initiatives, agent states, pending decisions, active tasks. No parameters required. Scope Class: Base domain tool (available in every domain-scoped endpoint) Scoped Domains:design, engineering, marketing, operations, orchestration, product, sales
orgx_sync
Push/pull memory sync with OrgX. Send local memory/daily log; receive initiatives, tasks, decisions, model routing policy.string
Local memory snapshot to push
string
Today’s session log to push
object[]
Optional local agent states to sync into OrgX
design, engineering, marketing, operations, orchestration, product, sales
Delegation & Assignment
orgx_delegation_preflight
Run delegation preflight to score scope quality, estimate ETA/cost, and suggest a split before autonomous execution.string
required
Task intent in natural language
string[]
Optional acceptance criteria to reduce ambiguity
string[]
Optional constraints (deadline, stack, policy)
string[]
Optional preferred owner domains
orgx_spawn_check
Check quality gate + get model routing before spawning a sub-agent. Returns allowed/denied, model tier, and check details.string
required
Agent domain (engineering, product, marketing, data, operations, design)
string
OrgX task ID to check
design, engineering, marketing, operations, orchestration, product, sales
Decision & Run Control
orgx_checkpoint_restore
Restore a run to a specific checkpoint.string
required
Run UUID
string
required
Checkpoint UUID
string
Optional restoration reason
orgx_checkpoints_list
List checkpoints for a run.string
required
Run UUID
orgx_request_decision
Alias for orgx_apply_changeset with decision.create. Request a human decision before proceeding.string
Initiative UUID (required unless ORGX_INITIATIVE_ID is set)
string
Optional run UUID
string
Required when run_id is omitted
string
Options:
openclaw, codex, claude-code, api.string
required
The decision question (e.g., ‘Deploy to production?’)
string
Background context to help the human decide
string[]
Available choices (e.g., [‘Yes, deploy now’, ‘Wait for more testing’,
‘Cancel’])
string
required
How urgent this decision is Options:
low, medium, high, urgent.boolean
Whether work should pause until this is decided (default: true)
design, engineering, marketing, operations, orchestration, product, sales
orgx_run_action
Apply a control action to a run: pause, resume, cancel, or rollback (rollback requires checkpointId).string
required
Run UUID
string
required
Control action Options:
pause, resume, cancel, rollback.string
Checkpoint UUID (required for rollback)
string
Optional reason for audit trail
Planning & Entity Management
orgx_apply_changeset
Apply an idempotent transactional OrgX changeset (launch reporting contract primary mutation tool).string
Initiative UUID (required unless ORGX_INITIATIVE_ID is set)
string
Idempotency key (<=120 chars). Auto-generated if omitted.
object[]
required
Changeset operations (task.create, task.update, milestone.update,
decision.create)
string
Optional run UUID
string
Required when run_id is omitted
string
Required when run_id is omitted Options:
openclaw, codex, claude-code,
api.operations, orchestration
orgx_create_entity
Create an OrgX entity (initiative, workstream, task, decision, milestone, etc.).string
required
Entity type: initiative, workstream, task, decision, milestone, artifact,
agent, blocker
string
required
Entity title
string
Description
string
Initial status (active, not_started, todo)
string
Parent initiative ID (for workstreams/tasks)
string
Parent workstream ID (for tasks)
string
Workspace ID (canonical; preferred for new callers)
string
Deprecated alias for workspace_id
orgx_reassign_stream
Reassign a workstream’s stream ownership/agents and return reassignment scheduling details.string
required
Workstream UUID to reassign
string
required
Parent initiative UUID
string
Optional workstream status override (active, in_progress, pending, etc.)
string
Optional target domain for the reassigned stream
string
Optional role hint for assignment routing
string[]
Optional assigned agent IDs
string[]
Alias for assigned_agent_ids
string[]
Optional assigned agent display names
string[]
Alias for assigned_agent_names
object[]
Optional structured assigned agent list
operations, orchestration
orgx_reassign_streams
Convenience batch reassignment tool. Takes initiative_id and a workstream-to-domain mapping, then updates all listed workstreams.string
required
Parent initiative UUID for all workstream updates
object
Mapping of workstream UUID -> target domain
object
Alias for workstream_domains: mapping of workstream UUID -> target domain
object[]
Optional array mapping for advanced routing fields (workstream_id, domain,
role, status).
string
Optional workstream status override applied to each reassigned stream
operations, orchestration
orgx_update_entity
Update an existing OrgX entity by type and ID.string
required
Entity type
string
required
Entity UUID
string
New status
string
New title
string
New summary
update_stream_progress
Legacy alias for orgx_report_progress. Report progress at key milestones so the team can track your work.string
Initiative UUID (required unless ORGX_INITIATIVE_ID is set)
string
Optional run UUID
string
Required when run_id is omitted
string
Options:
openclaw, codex, claude-code, api.string
required
What was accomplished (1-2 sentences, human-readable)
string
required
Current work phase Options:
researching, implementing, testing,
reviewing, blocked.number
Progress percentage (0-100)
string
What you plan to do next
design, engineering, marketing, operations, orchestration, product, sales
Quality, Proof & Outcomes
orgx_get_outcome_attribution
Compatibility alias for detailed outcome attribution on a task or run. Prefer orgx_get_morning_brief for current value and ROI review.string
Task ID to get attribution for
string
Run ID to get attribution for
design, engineering, marketing, operations, orchestration, product, sales
orgx_proof_status
Check the proof chain status for a task or run. Returns a checklist of proof levels (L1-L7) with gaps highlighted. Use this to verify work is provably complete before marking done.string
ID of the task to check proof for
string
ID of the run to check proof for
design, engineering, marketing, operations, orchestration, product, sales
orgx_quality_score
Record a quality score (1-5) for completed agent work. Used to gate future spawns and track performance.string
required
ID of the completed task
string
required
Agent domain that did the work
number
required
Quality 1 (poor) to 5 (excellent)
string
Notes on the assessment
design, engineering, marketing, operations, orchestration, product, sales
orgx_record_outcome
Record an outcome event for a completed run, linking execution to business value. Required for L5 (Impact) proof level.string
required
Initiative ID this outcome belongs to
string
required
Execution/run ID that produced this outcome
string
required
Agent that did the work
boolean
required
Whether the execution was successful
number
Quality score 1-5
string
Agent domain
object
Additional outcome metadata
design, engineering, marketing, operations, orchestration, product, sales
orgx_verify_completion
Verify that an entity (task/milestone/workstream) meets completion requirements including proof chain. Returns structured result with any blocking issues.string
required
Entity type: task, milestone, workstream
string
required
ID of the entity to verify
design, engineering, marketing, operations, orchestration, product, sales
Agent Policy & Configuration
get_agent_config
Get a single agent behavior config by id (default only).string
Agent config identifier. Use ‘default’.
boolean
When true, re-fetch behavior config policy from OrgX before returning data.
design, engineering, marketing, operations, orchestration, product, sales
list_agent_configs
List available agent behavior configs managed by this plugin.boolean
When true, re-fetch behavior config policy from OrgX before returning data.
design, engineering, marketing, operations, orchestration, product, sales
orgx_sentinel_catalog
List built-in proactive sentinel templates. Supports optional domain filter.string
Optional domain filter (engineering, sales, operations, product).
update_agent_config
Update plugin-managed agent behavior config policy (default config only).string
Agent config identifier. Use ‘default’.
boolean
Freeze remote skill-pack refresh when true.
string
Pin behavior policy to this exact checksum.
boolean
Pin to current local/remote checksum.
boolean
Clear any pinned checksum.
string
Use ‘rollback’ to revert to the previous config version.
string
Optional audit entry id to rollback to. When omitted with action=‘rollback’,
uses the most recent audit entry.
string
Optional preset template id. Currently supports ‘startup-speed’.
operations, orchestration
General
orgx_agent_sessions
List active CLI session IDs stored for workstreams. Used for session resume support.string
Optional initiative ID filter.
operations, orchestration
orgx_clear_agent_session
Clear stored CLI session IDs for an initiative (forces fresh sessions on next dispatch).string
required
Initiative UUID
orchestration
orgx_get_morning_brief
Get the morning brief value surface: session summary, value signals, exceptions, trust events, and top receipts. Preferred replacement for ROI summary lookups.string
required
Workspace ID to load the brief for
string
Optional autonomous session ID
design, engineering, marketing, operations, orchestration, product, sales
orgx_list_entities
List OrgX entities of a given type with optional status filter.string
required
Entity type: initiative, workstream, task, decision, agent
string
Filter by status
number
Max results (default 20) Default:
20.string
Filter by initiative ID
string
Legacy project/workspace scope filter
string
Workspace ID (canonical scope)
string
Deprecated alias for workspace_id
orgx_query_org_memory
Search OrgX organizational memory (decisions, initiatives, artifacts). Preferred replacement for older decision-history lookups.string
required
What to search for
string
Optional memory scope Options:
all, artifacts, decisions, initiatives.number
Max results to return
design, engineering, marketing, operations, orchestration, product, sales
orgx_recommend_next_action
Get the preferred next action for a workspace, initiative, workstream, or milestone. Preferred replacement for raw queue scoring in operator workflows.string
Entity type to recommend for (default: workspace) Options:
workspace,
initiative, workstream, milestone.string
Entity ID. For workspace, use “default” or a workspace ID.
string
Optional canonical workspace scope
string
Deprecated alias for workspace_id
number
Max recommendations to return
boolean
Refresh recommendations across the entity chain first
design, engineering, marketing, operations, orchestration, product, sales
orgx_resume_agent_session
Store or update a CLI session ID for a workstream so the next slice resumes it.string
required
Workstream UUID
string
required
CLI session UUID to resume
string
required
Initiative UUID
string
Source client (codex, claude-code)
orchestration