Skip to content

MCP tools reference ​

Use this reference to discover the tools that the Agentweaver Model Context Protocol (MCP) host exposes from the Gateway. The host reads GET /openapi/v1.json from its configured Gateway and caches the admitted operations. Each tool name is agentweaver_ followed by the OpenAPI operationId. The Gateway document defines each tool's path, parameters, request body, and summary.

For route authorization and native-only operations, see the HTTP API reference. For provider setup, see Configure providers. For host settings, see Runtime configuration.

Connect and authenticate ​

Download the v1 operator definition from the Gateway at GET /agents/agentweaver.agent.md. Save it as .github/agents/agentweaver.agent.md in a repository where you want to use it. The download is anonymous and returns Markdown; it is not an MCP tool. It does not write the file into project or run repositories automatically.

Before you connect, configure the absolute HTTPS Broker issuer, protected resource audience, and Gateway service root listed below. Obtain a valid Broker access token for the MCP audience. The host maps /mcp with the MCP SDK's stateless Streamable HTTP transport. It validates the token and forwards the same token to the configured Gateway; the MCP host does not issue another identity or grant.

Host configurationRequirement
Identity:IssuerAbsolute HTTPS Broker issuer.
Identity:AudienceAbsolute HTTPS protected-resource audience.
Gateway:BaseAddressAbsolute HTTPS Gateway service root, without a path.

To discover and call tools:

  1. Send an authenticated MCP initialize request to /mcp.
  2. Call tools/list to retrieve the exact schemas from the configured Gateway.
  3. Call a listed tool with tools/call and arguments that match its schema.

The host derives the protected-resource metadata path from the audience path. For an audience ending in /mcp, discovery uses /.well-known/oauth-protected-resource/mcp. The metadata returns resource and authorization_servers. If /mcp returns 401, use the metadata URI in the WWW-Authenticate challenge to identify the protected resource.

GET /health/live and GET /health/ready are anonymous process checks. They do not validate a Gateway tool call.

Arguments ​

InputMapping
Path parameter, such as projectIdRequired parameter with the same name; each value is URI-escaped.
Query parameter, such as cursorAdvertised scalar property with the same name.
tenantSelectorX-Agentweaver-Tenant; required for Source Control tools, optional where advertised elsewhere.
idempotencyKeyIdempotency-Key; required for Knowledge writes.
bodyJSON body defined by the operation's request schema.

The input schema rejects unknown properties. Body fields are not flattened into top-level tool arguments. Operations whose idempotency key belongs inside the owner request body retain that field inside body.

Use tools/list to get the exact schema from the configured Gateway. The operation list on this page is an index; the live schema is authoritative for the configured Gateway.

Tool index ​

Every name below has the agentweaver_ prefix. For example, listProjects is agentweaver_listProjects. These are the operation IDs in the checked-in GatewayRouteCatalog.

Caller attention ​

Operation IDPurpose
listUserNotificationsRead pending attention across authorized projects and runs; supports cursor, page size, project filter and dismissed-item inclusion.
dismissUserNotificationDismiss a notification for the caller without resolving its gate.

These operations come from the same Gateway catalog as the existing tools. There is no separate Chief of Staff notification store or bell. See Notifications.

Projects and configuration ​

Operation IDPurpose
listProjectsList visible projects.
createProjectCreate a project; does not assign an Owner.
getProjectRead project metadata.
getProjectAgentHistoryRead an agent's bounded history using current caller authority.
updateProjectUpdate metadata at an expected revision.
listProjectRoleAssignmentsRead project role assignments.
assignProjectRoleAssign a project role through owner authorization.
revokeProjectRoleAssignmentRevoke a project role assignment.
getProjectConfigurationRead current or retained configuration.
getProjectConfigurationChoicesRead available project model and provider choices.
getHostedModelReasoningCatalogRead live hosted reasoning levels and availability.
updateProjectConfigurationAppend a configuration revision.
getAuthorizationContextRead current tenant and effective authority.
getPlatformRuntimeDefaultsRead platform defaults.
updatePlatformRuntimeDefaultsAppend platform defaults.
getPlatformComponentsRead active platform components and their readiness.
acceptRunSelectionAccept an immutable run selection.
getRunSelectionRead the accepted selection.
readIssueSyncRead periodic issue sync status.
configureIssueSyncEnable, disable, and bound periodic issue sync.
createIssueSyncGrantCreate project issue-sync authority.
readIssueSyncGrantValidate current issue-sync authority.
revokeIssueSyncGrantRevoke project issue-sync authority.
listRemoteMcpConnectionsList Remote MCP connections with configuration checksums.

Casting ​

Casting tools forward the bearer and optional tenant selector to Projects. Revision checks stay inside body; no idempotency header is required.

Operation IDPurpose
createProjectCastingProposalStage a complete configuration draft.
createScenarioProjectCastingProposalStage a built-in scenario.
createManualProjectCastingProposalStage selected catalog roles.
listProjectCastingProposalsList proposals with optional limit.
getProjectCastingProposalRead a proposal.
updateProjectCastingProposalReplace a pending draft at its expected revision.
confirmProjectCastingProposalConfirm reviewed casting at current revisions.
rejectProjectCastingProposalReject without changing configuration.
exportProjectCastingExport charters and casting; requires write authority.
importProjectCastingStage a digest-checked transfer; request body limit 1 MiB.
listProjectCastingTemplatesRead built-in templates.
listProjectCastingRolesRead built-in roles.

Project backlog ​

Operation IDPurpose
readProjectBacklogRead project backlog tasks and dependencies.
captureBacklogTaskCapture project backlog work.
editBacklogTaskContentReplace backlog task content and lifecycle.
setProjectBacklogTaskStateQueue or return an unclaimed task.
archiveProjectBacklogTaskArchive an unclaimed task.
addProjectBacklogDependencyAdd a prerequisite to a task.
removeProjectBacklogDependencyRemove a task prerequisite.
claimBacklogTaskAtomically claim eligible work for an accepted run with an idempotency key.

Skills and marketplace ​

Operation IDPurpose
listMarketplaceDefinitionsList suggested marketplaces for a project.
listMarketplaceSourcesList project marketplace sources.
createMarketplaceSourceAdd a public source.
updateMarketplaceSourceAppend a source revision.
removeMarketplaceSourceTombstone a source at an expected revision.
browseMarketplaceSourceBrowse a selected source revision.
previewMarketplaceSkillValidate selected content at the pinned commit.
importMarketplaceSkillImport the selected, previewed content.
previewSkillContentValidate submitted local content without importing.
packageSkillContentTurn uploaded files, a ZIP archive, or draft fields into skill candidates.
importProjectSkillImport validated local content.
updateProjectSkillAssignmentUpdate project assignments at an expected configuration revision.
listProjectSkillInventoryRead paginated revision metadata.
revokeProjectSkillRevisionRevoke one imported skill revision with a reason.

AgentSuite packages ​

Operation IDPurpose
exportProjectAgentSuiteExport the current or requested configuration revision as a validator-checked content-tar-gzip package; archive limit 5 MiB.
importProjectAgentSuiteValidate an AgentSuite archive and stage a casting proposal; request body limit 24 MiB.
getProjectAgentSuiteImportRead a retained AgentSuite import record by source identity.
getProjectAgentSuiteAgentPolicyRead the policy bound to an imported agent. The policy is not enforced.

Export returns a portable package. Import doesn't activate or run agents. Confirm or reject the staged proposal with the casting tools. See AgentSuite import and export.

Coordination ​

Operation IDPurpose
acceptRunRootAccept root owner state.
createProjectRunCreate an interactive run.
startProjectRunDeliver the first run message.
cancelProjectRunCancel a run.
listProjectRunsList accepted project runs, newest first.
getProjectRunHistorySessionsRead a run's sessions with current project read authority and tenant ownership checks.
listProjectIssuesList synced repository issues stored in the project backlog.
listProjectPullRequestsList pull requests that project runs recorded after migration 032 was applied.
readProjectMetricsRead bounded project run counts and daily UTC activity from Orchestrator.
listChiefOfStaffConversationsList my private Chief of Staff conversations.
bindChiefOfStaffConversationBind a run I created to a Chief of Staff conversation.
getChiefOfStaffConversationRead one of my Chief of Staff conversations.
listChiefOfStaffPrioritiesList my ordered Priorities with resolved links.
createChiefOfStaffPriorityCreate a Priority. Requires Idempotency-Key.
reorderChiefOfStaffPrioritiesReorder my Priorities at an expected order revision.
getChiefOfStaffPriorityRead one Priority.
updateChiefOfStaffPriorityChange a Priority at an expected revision. Never changes run state.
addChiefOfStaffPriorityLinkLink a Priority to a run, conversation, issue, pull request, or artifact. Issue and pull request bodies include providerId, repository: { owner, name }, and number; before the database update they return database_update_pending.
removeChiefOfStaffPriorityLinkRemove a Priority link at an expected revision.
proposeOutcomePropose an outcome decision.
readRunStatusRead current run owner state.
recoverRunRequest owner recovery.
proposeOutcomeSpecSubmit an outcome specification.
selectWorkflowSelect a workflow.
proposeWorkPlanSubmit a work plan.
reviseWorkPlanSubmit a revised plan.
requestAssemblyRequest assembly.
readDecisionsRead decision state and pending gate.
readSessionTreeRead the session tree.
readSessionStatusRead lifecycle, activity, and blockers.
readRuntimeObservationV1Read current runtime evidence.
reportTurnFailureReport a failed turn.
answerGateAnswer an exact question gate.
askQuestionRequest a question gate.
askOutcomeQuestionRequest the next outcome question.
requestApprovalRequest an approval gate.
acknowledgeGateAcknowledge a gate.
registerChildRegister a child session.
spawnSessionRequest a child spawn; acceptance is not execution.
forkSessionFork a session through owner admission.
detachSessionDetach a child.
archiveChildArchive an eligible child.
subscribeToIdleRequest an idle subscription.
steerSessionSubmit steering.
approveGateApprove an exact pending gate.
rejectGateReject an exact pending gate.
sendMessageSubmit an addressed message; acceptance is not delivery.
advanceTurnBoundaryAdvance an owner turn boundary.
completeTurnRecord turn completion.
readNotificationsRead owner notifications.
acknowledgeNotificationAcknowledge a notification.
acknowledgeMessageAcknowledge a message.
readPolicyEvaluationRead a policy receipt.
validatePolicyEvaluationAdmissionRevalidate receipt admission.

readProjectMetrics accepts optional from, to, and bucket=day. readProjectUsage accepts optional from and to, and reads Events & Sessions ledger totals grouped by model and agent. Both tools use fresh project read authority and a half-open UTC interval of at most 92 days, defaulting to the last 30 days. A run-bound caller sees only its own run. Cost units and dispositions remain separate, unknown values remain null, and usage reads do not price or change budgets. Cross-project overview is out of scope. See Project metrics and usage for metric definitions and differences from the 0.x dashboard.

Source Control ​

Operation IDPurpose
pinSourceControlRepositoryPin a run repository; body is optional for legacy secret mode.
createSourceControlIssueCreate a repository issue.
createSourceControlPullRequestCreate or reuse a pull request.
readSourceControlReviewsRead pull request reviews.
prepareSourceControlWorkspacePrepare a pinned repository workspace.
readSourceControlWorkspaceDiffRead a workspace diff.
prepareSourceControlMergeIntentRequest merge approval.
readSourceControlMergeIntentRead a merge intent.
executeSourceControlMergeIntentExecute an approved intent.
captureSourceControlWorkspaceOutputCapture the produced output of a workspace.
listSourceControlOutputCapturesList admitted output captures, newest first.
readSourceControlOutputCaptureRead a capture and its file list.
readSourceControlOutputCaptureDiffRead the diff of a capture.
readSourceControlOutputCaptureFileRead one captured file. The tool returns the body as text.

Knowledge ​

Operation IDPurpose
createKnowledgeRecordCreate a scoped record.
searchKnowledgeSearch and page records.
searchProjectKnowledgeSearch across existing project Memory bindings and agents.
readKnowledgeRecordRead one record.
updateKnowledgeRecordApply a revision-checked update.
restoreKnowledgeRecordAppend a restored revision.
approveKnowledgeDecisionApprove a Decision.
exportKnowledgeRecordsExport an exact-scope bundle.
importKnowledgeRecordsImport a validated bundle.
readKnowledgeRevisionsRead revision history.
promoteKnowledgeProposalPromote a Proposal through owner validation.
rejectKnowledgeProposalReject a Proposal.
compileKnowledgeContextCompile bounded agent context.

Events and usage ​

Operation IDPurpose
replayRunEventsRead a finite committed journal page.
replayProjectRunHistoryEventsRead run activity with current project read authority and tenant ownership checks.
readSessionTurnContentRead recorded turn text with current run-bound project authority. Excludes cache, configuration, and tool-result material.
readRunUsageRead run usage totals.
readProjectUsageRead persisted project usage grouped by model and agent.

Results and errors ​

Successful dispatch returns text plus structured content:

json
{
  "status": 202,
  "ownerResponse": {}
}

status preserves the HTTP status. ownerResponse contains the parsed owner JSON, a string for non-JSON text, or null for an empty response. IsError is true for HTTP errors or an owner response with accepted: false.

An accepted-only operation or HTTP 202 is described as acceptance, not completion. Read current owner state to establish the result.

Local error codes include unknown_tool, invalid_arguments, gateway_contract_invalid, gateway_timeout, gateway_unavailable, unauthenticated, and gateway_response_too_large.

Limits and exclusions ​

  • The catalog supports GET, POST, PUT, PATCH, and DELETE under /api/v1/.
  • streamRunEvents is excluded because it is SSE. Use finite replay tools.
  • Browser connection lifecycle routes and callbacks are outside the catalog.
  • Native-only run backlog, runtime, Environment, and private material routes are not tools.
  • Catalog downloads are limited to 2 MiB; owner responses are limited to 8 MiB. Gateway request deadlines are ten seconds.
  • The host does not add background scheduling or automatic execution.

Source ​