Read an MCP application resource for a visitor task¶
Resources must be bound by the task manifest, not arbitrary proxied URLs. Execution restores publisher identity. Returns uri/contents; content union types and resource limits still require the full MCP contract.
POST https://api.moi.matrixorigin.cn/v5/public/webapp/mcp-apps/resource
Before you call this API¶
BASE_URL uses the product API prefix https://api.moi.matrixorigin.cn/v5. For a dedicated deployment, use its corresponding product API address.
Prepare links and visitor identity in the same environment. Do not supply a product PAT or Workspace request header.
Request¶
curl --request POST \
"$BASE_URL/public/webapp/mcp-apps/resource?webapp=$AGENT_ID&t=$WEBAPP_TOKEN&s=$WEBAPP_SESSION" \
--header "Content-Type: application/json" \
--data @- <<JSON
{"conversation_id": "${CONVERSATION_ID}", "task_id": "$TASK_ID", "uri": "ui://example/app.html"}
JSON
Parameter |
Location |
Type |
Required |
Description |
|---|---|---|---|---|
|
Query |
string |
Yes |
Agent ID corresponding to the link. |
|
Query |
string |
Yes |
Current valid publication token. For short-code links, resolve first and use the short code as t. |
|
Query |
string |
Yes |
Visitor session credentials under the same publication. |
|
Body |
string |
Yes |
This visitor conversation ID. |
|
Body |
string |
Yes |
Task ID within that conversation. |
|
Body |
string |
No |
Tool selection from the target task manifest. |
|
Body |
string |
Yes |
MCP resource URI bound by the task manifest. |
Successful response¶
{
"code": 0,
"data": {
"uri": "ui://example/app.html",
"contents": []
}
}
Success returns HTTP 200 with numeric code=0. Read data’s Object descriptions with the example; the conversation-creation example shows a field excerpt only.
Error response¶
Public errors and identity handling distinguishes unavailable links, disablement, invalid sessions, parameters, and system failures.