On by default

Data Explorer

Get Data Explorer Query

read-onlyidempotentopen-world

discourse_get_query

Get full details of a Data Explorer query including SQL and parameters. Requires admin API key.

Get Data Explorer Query

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "discourse_get_query",
    "arguments": {
        "id": 0
      }
  }
}

const result = await client.callTool({
  "name": "discourse_get_query",
  "arguments": {
    "id": 0
  }
});

result = await session.call_tool("discourse_get_query", arguments={
  "id": 0
})

Parameters

idintegerrequired

Query ID

Run Data Explorer Query

read-onlyidempotentopen-world

discourse_run_query

Execute a Data Explorer query with parameters. Returns columns, rows, result_count, duration_ms. Queries run in read-only transactions with 10-second timeout. Requires admin API key.

Run Data Explorer Query

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "discourse_run_query",
    "arguments": {
        "id": 0,
        "params": {},
        "limit": 0,
        "explain": true
      }
  }
}

const result = await client.callTool({
  "name": "discourse_run_query",
  "arguments": {
    "id": 0,
    "params": {},
    "limit": 0,
    "explain": true
  }
});

result = await session.call_tool("discourse_run_query", arguments={
  "id": 0,
  "params": {},
  "limit": 0,
  "explain": true
})

Request Body

{
  "id": 0,
  "params": {},
  "limit": 0,
  "explain": true
}

Body

application/json

idintegerrequired

Query ID to run

paramsobject

Query parameters as key-value pairs

Show child attributes

[key: string]any

limitinteger | string

Maximum number of rows to return (default: query default, use 'ALL' for unlimited)

Show child attributes

Any of

integer

string

explainboolean

Include query execution plan in response

Create Data Explorer Query

discourse_create_query

Create a new saved Data Explorer query. Requires admin API key and write access.

Create Data Explorer Query

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "discourse_create_query",
    "arguments": {
        "name": "string",
        "sql": "string",
        "description": "string",
        "group_ids": [
          0
        ]
      }
  }
}

const result = await client.callTool({
  "name": "discourse_create_query",
  "arguments": {
    "name": "string",
    "sql": "string",
    "description": "string",
    "group_ids": [
      0
    ]
  }
});

result = await session.call_tool("discourse_create_query", arguments={
  "name": "string",
  "sql": "string",
  "description": "string",
  "group_ids": [
    0
  ]
})

Parameters

namestringrequired

Query name

sqlstringrequired

SQL query. Declare parameters in comments: -- [params]\n-- int :user_id

descriptionstring

Query description

group_idsArray<integer>

Group IDs allowed to run this query (empty = admin only)

Update Data Explorer Query

discourse_update_query

Update an existing Data Explorer query. Only provided fields are updated. Requires admin API key and write access.

Update Data Explorer Query

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "discourse_update_query",
    "arguments": {
        "id": 0,
        "name": "string",
        "sql": "string",
        "description": "string",
        "group_ids": [
          0
        ]
      }
  }
}

const result = await client.callTool({
  "name": "discourse_update_query",
  "arguments": {
    "id": 0,
    "name": "string",
    "sql": "string",
    "description": "string",
    "group_ids": [
      0
    ]
  }
});

result = await session.call_tool("discourse_update_query", arguments={
  "id": 0,
  "name": "string",
  "sql": "string",
  "description": "string",
  "group_ids": [
    0
  ]
})

Parameters

idintegerrequired

Query ID to update

namestring

New query name

sqlstring

New SQL query

descriptionstring

New query description

group_idsArray<integer>

New group IDs allowed to run this query

Delete Data Explorer Query

discourse_delete_query

Soft-delete a Data Explorer query. The query can be restored by an admin. Requires admin API key and write access.

Delete Data Explorer Query

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "discourse_delete_query",
    "arguments": {
        "id": 0
      }
  }
}

const result = await client.callTool({
  "name": "discourse_delete_query",
  "arguments": {
    "id": 0
  }
});

result = await session.call_tool("discourse_delete_query", arguments={
  "id": 0
})

Parameters

idintegerrequired

Query ID to delete

Docs by Sourcey