Generated from plugin version
0.7.28 in
../../orgx-openclaw-plugin-tool-guidance. Regenerate with pnpm docs:generate-openclaw-plugin.Endpoint Model
| Endpoint | Purpose |
|---|---|
/orgx/mcp | Full plugin tool surface (all 33 tools). |
/orgx/mcp/{domain} | Domain-safe subset of tools. |
Scoped Domains
| Domain | Tool Count | Additional Tools Beyond Base |
|---|---|---|
engineering | 18 | None |
product | 18 | None |
design | 18 | None |
marketing | 18 | None |
sales | 18 | None |
operations | 23 | orgx_agent_sessions, orgx_apply_changeset, orgx_reassign_stream, orgx_reassign_streams, update_agent_config |
orchestration | 25 | orgx_agent_sessions, orgx_apply_changeset, orgx_clear_agent_session, orgx_reassign_stream, orgx_reassign_streams, orgx_resume_agent_session, update_agent_config |
Tool Catalog
| Category | Tools |
|---|---|
| Sync & Reporting | orgx_emit_activity, orgx_register_artifact, orgx_report_progress, orgx_status, orgx_sync |
| Delegation & Assignment | orgx_delegation_preflight, orgx_spawn_check |
| Decision & Run Control | orgx_checkpoint_restore, orgx_checkpoints_list, orgx_request_decision, orgx_run_action |
| Planning & Entity Management | orgx_apply_changeset, orgx_create_entity, orgx_reassign_stream, orgx_reassign_streams, orgx_update_entity, update_stream_progress |
| Quality, Proof & Outcomes | orgx_get_outcome_attribution, orgx_proof_status, orgx_quality_score, orgx_record_outcome, orgx_verify_completion |
| Agent Policy & Configuration | get_agent_config, list_agent_configs, orgx_sentinel_catalog, update_agent_config |
| General | orgx_agent_sessions, orgx_clear_agent_session, orgx_get_morning_brief, orgx_list_entities, orgx_query_org_memory, orgx_recommend_next_action, orgx_resume_agent_session |
Sync & Reporting
orgx_emit_activity
Emit append-only OrgX activity telemetry (launch reporting contract primary write tool).Initiative UUID (required unless ORGX_INITIATIVE_ID is set)
Human-readable activity update
Optional run UUID
Required when run_id is omitted
Required when run_id is omitted Options:
openclaw, codex, claude-code,
api.Reporting phase Options:
intent, execution, blocked, review,
handoff, completed.Optional progress percentage
Optional level (default info) Options:
info, warn, error.Optional next step
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.Convenience: initiative UUID. Used as entity_type=‘initiative’,
entity_id=<this> when entity_type/entity_id are not provided.
The type of entity this artifact is attached to Options:
initiative,
milestone, task, decision, project.UUID of the entity this artifact is attached to
Human-readable artifact name (e.g., ‘PR #107: Fix build size’)
Artifact type code (e.g., ‘eng.diff_pack’, ‘pr’, ‘document’). Falls back to
‘shared.project_handbook’ if the type is not recognized by OrgX.
Self-assessed confidence for this artifact in [0,1].
What this artifact is and why it matters
External link to the artifact (PR URL, file path, etc.)
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.Initiative UUID (required unless ORGX_INITIATIVE_ID is set)
Optional run UUID
Required when run_id is omitted
Options:
openclaw, codex, claude-code, api.What was accomplished (1-2 sentences, human-readable)
Current work phase Options:
researching, implementing, testing,
reviewing, blocked.Progress percentage (0-100)
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.Local memory snapshot to push
Today’s session log to push
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.Task intent in natural language
Optional acceptance criteria to reduce ambiguity
Optional constraints (deadline, stack, policy)
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.Agent domain (engineering, product, marketing, data, operations, design)
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.Run UUID
Checkpoint UUID
Optional restoration reason
orgx_checkpoints_list
List checkpoints for a run.Run UUID
orgx_request_decision
Alias for orgx_apply_changeset with decision.create. Request a human decision before proceeding.Initiative UUID (required unless ORGX_INITIATIVE_ID is set)
Optional run UUID
Required when run_id is omitted
Options:
openclaw, codex, claude-code, api.The decision question (e.g., ‘Deploy to production?’)
Background context to help the human decide
Available choices (e.g., [‘Yes, deploy now’, ‘Wait for more testing’,
‘Cancel’])
How urgent this decision is Options:
low, medium, high, urgent.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).Run UUID
Control action Options:
pause, resume, cancel, rollback.Checkpoint UUID (required for rollback)
Optional reason for audit trail
Planning & Entity Management
orgx_apply_changeset
Apply an idempotent transactional OrgX changeset (launch reporting contract primary mutation tool).Initiative UUID (required unless ORGX_INITIATIVE_ID is set)
Idempotency key (<=120 chars). Auto-generated if omitted.
Changeset operations (task.create, task.update, milestone.update,
decision.create)
Optional run UUID
Required when run_id is omitted
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.).Entity type: initiative, workstream, task, decision, milestone, artifact,
agent, blocker
Entity title
Description
Initial status (active, not_started, todo)
Parent initiative ID (for workstreams/tasks)
Parent workstream ID (for tasks)
Workspace ID (canonical; preferred for new callers)
Deprecated alias for workspace_id
orgx_reassign_stream
Reassign a workstream’s stream ownership/agents and return reassignment scheduling details.Workstream UUID to reassign
Parent initiative UUID
Optional workstream status override (active, in_progress, pending, etc.)
Optional target domain for the reassigned stream
Optional role hint for assignment routing
Optional assigned agent IDs
Alias for assigned_agent_ids
Optional assigned agent display names
Alias for assigned_agent_names
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.Parent initiative UUID for all workstream updates
Mapping of workstream UUID -> target domain
Alias for workstream_domains: mapping of workstream UUID -> target domain
Optional array mapping for advanced routing fields (workstream_id, domain,
role, status).
Optional workstream status override applied to each reassigned stream
operations, orchestration
orgx_update_entity
Update an existing OrgX entity by type and ID.Entity type
Entity UUID
New status
New title
New summary
update_stream_progress
Legacy alias for orgx_report_progress. Report progress at key milestones so the team can track your work.Initiative UUID (required unless ORGX_INITIATIVE_ID is set)
Optional run UUID
Required when run_id is omitted
Options:
openclaw, codex, claude-code, api.What was accomplished (1-2 sentences, human-readable)
Current work phase Options:
researching, implementing, testing,
reviewing, blocked.Progress percentage (0-100)
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.Task ID to get attribution for
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.ID of the task to check proof for
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.ID of the completed task
Agent domain that did the work
Quality 1 (poor) to 5 (excellent)
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.Initiative ID this outcome belongs to
Execution/run ID that produced this outcome
Agent that did the work
Whether the execution was successful
Quality score 1-5
Agent domain
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.Entity type: task, milestone, workstream
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).Agent config identifier. Use ‘default’.
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.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.Optional domain filter (engineering, sales, operations, product).
update_agent_config
Update plugin-managed agent behavior config policy (default config only).Agent config identifier. Use ‘default’.
Freeze remote skill-pack refresh when true.
Pin behavior policy to this exact checksum.
Pin to current local/remote checksum.
Clear any pinned checksum.
Use ‘rollback’ to revert to the previous config version.
Optional audit entry id to rollback to. When omitted with action=‘rollback’,
uses the most recent audit entry.
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.Optional initiative ID filter.
operations, orchestration
orgx_clear_agent_session
Clear stored CLI session IDs for an initiative (forces fresh sessions on next dispatch).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.Workspace ID to load the brief for
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.Entity type: initiative, workstream, task, decision, agent
Filter by status
Max results (default 20) Default:
20.Filter by initiative ID
Legacy project/workspace scope filter
Workspace ID (canonical scope)
Deprecated alias for workspace_id
orgx_query_org_memory
Search OrgX organizational memory (decisions, initiatives, artifacts). Preferred replacement for older decision-history lookups.What to search for
Optional memory scope Options:
all, artifacts, decisions, initiatives.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.Entity type to recommend for (default: workspace) Options:
workspace,
initiative, workstream, milestone.Entity ID. For workspace, use “default” or a workspace ID.
Optional canonical workspace scope
Deprecated alias for workspace_id
Max recommendations to return
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.Workstream UUID
CLI session UUID to resume
Initiative UUID
Source client (codex, claude-code)
orchestration
