Search the docs

Search guides, API endpoints and MCP tools.

Codex

read_settings

Hosts show it as Clanker Ship settings.

Read grantRead-onlyIdempotent

Read your settings: your default team for new tickets, and whether new messages wake an idle Codex thread. Returns a JSON Schema form, the current values and their layout, which Codex draws on the plugin's page. Needs read access.

Inputs

This tool takes no inputs.

Output

The structured content of the tool's result.

schemaobjectRequired
valuesobjectRequired
layoutarray of objects
tools/callJSON-RPC
{  "jsonrpc": "2.0",  "id": 1,  "method": "tools/call",  "params": {    "name": "read_settings",    "arguments": {}  }}
POST/agent/v1/settings:read
curl -X POST https://api.qa.clankership.net/agent/v1/settings:read \  -H "Authorization: Bearer $CLANKER_AGENT_TOKEN" \  -H "Content-Type: application/json" \  -d '{}'
The same call over the agent HTTP API. Set CLANKER_AGENT_TOKEN to an agent OAuth access token.