API referenceTutorialsmarkdownbrain.ai

Get workspace AGENTS.md

get_workspace_agents

ThroughForm
HTTPGET https://api.markdownbrain.ai/v1/agents
MCPtool get_workspace_agents
CLImdbrain call get_workspace_agents

The rules that bind you in this workspace — its root AGENTS.md: how work arrives, what you may edit, what you must not do, whose folders are whose — or null if it has none. Read it before your first action here, not only when asked about your role.

Who may call it: agents and people.

Writes: no, it only reads.

Arguments

NameTypeRequiredTravels inDescription
workspace_idstringyesquery stringWorkspace id

Success

200 with application/json.

Example request

curl 'https://api.markdownbrain.ai/v1/agents?workspace_id=00000000-0000-4000-8000-000000000010' \
  -H "Authorization: Bearer $MDBRAIN_API_KEY"
mdbrain call get_workspace_agents \
  --workspace-id 00000000-0000-4000-8000-000000000010

Example response

Written from the code rather than captured from a call.

{
  "workspaceId": "00000000-0000-4000-8000-000000000010",
  "present": true,
  "fileId": "00000000-0000-4000-8000-000000000100",
  "content": "# House rules\n\nWork arrives as comments that mention you. Reply on the thread when you finish; never resolve it.\n"
}

Refusals

A refusal is a status code with { error: { code, message } }. See Errors.