Comments

get_comments

Get list of comments for the authenticated user's organization

get_comments

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_comments",
    "arguments": {
        "page": 1,
        "limit": 10,
        "search": "string",
        "relations": [
          "string"
        ],
        "entity": "TASK",
        "entityId": "550e8400-e29b-41d4-a716-446655440000",
        "employeeId": "550e8400-e29b-41d4-a716-446655440000",
        "parentId": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "get_comments",
  "arguments": {
    "page": 1,
    "limit": 10,
    "search": "string",
    "relations": [
      "string"
    ],
    "entity": "TASK",
    "entityId": "550e8400-e29b-41d4-a716-446655440000",
    "employeeId": "550e8400-e29b-41d4-a716-446655440000",
    "parentId": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("get_comments", arguments={
  "page": 1,
  "limit": 10,
  "search": "string",
  "relations": [
    "string"
  ],
  "entity": "TASK",
  "entityId": "550e8400-e29b-41d4-a716-446655440000",
  "employeeId": "550e8400-e29b-41d4-a716-446655440000",
  "parentId": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

searchstring

Search term for comment content

relationsArray<string>

Relations to include (e.g., ["createdBy", "employee", "parent", "replies"])

entitystringTASKPROJECTGOALCANDIDATEDEALINVOICEOTHER

Filter by entity type

entityIdstring<uuid>

Filter by entity ID

employeeIdstring<uuid>

Filter by employee ID

parentIdstring<uuid>

Filter by parent comment ID (for replies)

get_comment_count

Get comment count in the authenticated user's organization

get_comment_count

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_comment_count",
    "arguments": {
        "entity": "TASK",
        "entityId": "550e8400-e29b-41d4-a716-446655440000",
        "employeeId": "550e8400-e29b-41d4-a716-446655440000",
        "parentId": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "get_comment_count",
  "arguments": {
    "entity": "TASK",
    "entityId": "550e8400-e29b-41d4-a716-446655440000",
    "employeeId": "550e8400-e29b-41d4-a716-446655440000",
    "parentId": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("get_comment_count", arguments={
  "entity": "TASK",
  "entityId": "550e8400-e29b-41d4-a716-446655440000",
  "employeeId": "550e8400-e29b-41d4-a716-446655440000",
  "parentId": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

entitystringTASKPROJECTGOALCANDIDATEDEALINVOICEOTHER

Filter by entity type

entityIdstring<uuid>

Filter by entity ID

employeeIdstring<uuid>

Filter by employee ID

parentIdstring<uuid>

Filter by parent comment ID

get_comment

Get a specific comment by ID

get_comment

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_comment",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_comment",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_comment", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "relations": [
    "string"
  ]
})

Parameters

idstring<uuid>required

The comment ID

relationsArray<string>

Relations to include (e.g., ["createdBy", "employee", "parent", "replies"])

create_comment

Create a new comment in the authenticated user's organization

create_comment

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_comment",
    "arguments": {
        "comment_data": {
          "comment": "string",
          "entity": "string",
          "entityId": "string"
        }
      }
  }
}

const result = await client.callTool({
  "name": "create_comment",
  "arguments": {
    "comment_data": {
      "comment": "string",
      "entity": "string",
      "entityId": "string"
    }
  }
});

result = await session.call_tool("create_comment", arguments={
  "comment_data": {
    "comment": "string",
    "entity": "string",
    "entityId": "string"
  }
})

Request Body

{
  "comment_data": {
    "comment": "string",
    "entity": "string",
    "entityId": "string"
  }
}

Body

application/json

comment_dataobjectrequired

The data for creating the comment

Show child attributes

commentstringrequired

The comment text (required)

entitystringrequired

The entity type (required)

entityIdstringrequired

The entity ID (required)

[key: string]any

update_comment

Update an existing comment

update_comment

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_comment",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "comment_data": {
          "comment": "string"
        }
      }
  }
}

const result = await client.callTool({
  "name": "update_comment",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "comment_data": {
      "comment": "string"
    }
  }
});

result = await session.call_tool("update_comment", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "comment_data": {
    "comment": "string"
  }
})

Request Body

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "comment_data": {
    "comment": "string"
  }
}

Body

application/json

idstring<uuid>required

The comment ID

comment_dataobjectrequired

The data for updating the comment (only comment text can be updated)

Show child attributes

commentstringrequired

The comment text

delete_comment

Delete a comment

delete_comment

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "delete_comment",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "delete_comment",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("delete_comment", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

idstring<uuid>required

The comment ID

get_comments_by_entity

Get all comments for a specific entity

get_comments_by_entity

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_comments_by_entity",
    "arguments": {
        "entity": "TASK",
        "entityId": "550e8400-e29b-41d4-a716-446655440000",
        "page": 1,
        "limit": 10,
        "relations": [
          "string"
        ],
        "includeReplies": true
      }
  }
}

const result = await client.callTool({
  "name": "get_comments_by_entity",
  "arguments": {
    "entity": "TASK",
    "entityId": "550e8400-e29b-41d4-a716-446655440000",
    "page": 1,
    "limit": 10,
    "relations": [
      "string"
    ],
    "includeReplies": true
  }
});

result = await session.call_tool("get_comments_by_entity", arguments={
  "entity": "TASK",
  "entityId": "550e8400-e29b-41d4-a716-446655440000",
  "page": 1,
  "limit": 10,
  "relations": [
    "string"
  ],
  "includeReplies": true
})

Parameters

entitystringTASKPROJECTGOALCANDIDATEDEALINVOICEOTHERrequired

The entity type

entityIdstring<uuid>required

The entity ID

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

relationsArray<string>

Relations to include

includeRepliesbooleantrue

Include reply comments

reply_to_comment

Reply to an existing comment

reply_to_comment

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "reply_to_comment",
    "arguments": {
        "parentId": "550e8400-e29b-41d4-a716-446655440000",
        "comment": "string",
        "entity": "TASK",
        "entityId": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "reply_to_comment",
  "arguments": {
    "parentId": "550e8400-e29b-41d4-a716-446655440000",
    "comment": "string",
    "entity": "TASK",
    "entityId": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("reply_to_comment", arguments={
  "parentId": "550e8400-e29b-41d4-a716-446655440000",
  "comment": "string",
  "entity": "TASK",
  "entityId": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

parentIdstring<uuid>required

The parent comment ID

commentstringrequired

The reply comment text

entitystringTASKPROJECTGOALCANDIDATEDEALINVOICEOTHERrequired

The entity type

entityIdstring<uuid>required

The entity ID

get_comment_replies

Get all replies to a specific comment

get_comment_replies

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_comment_replies",
    "arguments": {
        "parentId": "550e8400-e29b-41d4-a716-446655440000",
        "page": 1,
        "limit": 10,
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_comment_replies",
  "arguments": {
    "parentId": "550e8400-e29b-41d4-a716-446655440000",
    "page": 1,
    "limit": 10,
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_comment_replies", arguments={
  "parentId": "550e8400-e29b-41d4-a716-446655440000",
  "page": 1,
  "limit": 10,
  "relations": [
    "string"
  ]
})

Parameters

parentIdstring<uuid>required

The parent comment ID

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

relationsArray<string>

Relations to include

get_my_comments

Get comments created by the current authenticated user

get_my_comments

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_my_comments",
    "arguments": {
        "page": 1,
        "limit": 10,
        "entity": "TASK",
        "entityId": "550e8400-e29b-41d4-a716-446655440000",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_my_comments",
  "arguments": {
    "page": 1,
    "limit": 10,
    "entity": "TASK",
    "entityId": "550e8400-e29b-41d4-a716-446655440000",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_my_comments", arguments={
  "page": 1,
  "limit": 10,
  "entity": "TASK",
  "entityId": "550e8400-e29b-41d4-a716-446655440000",
  "relations": [
    "string"
  ]
})

Parameters

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

entitystringTASKPROJECTGOALCANDIDATEDEALINVOICEOTHER

Filter by entity type

entityIdstring<uuid>

Filter by entity ID

relationsArray<string>

Relations to include

add_comment_to_task

Add a comment to a specific task

add_comment_to_task

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "add_comment_to_task",
    "arguments": {
        "taskId": "550e8400-e29b-41d4-a716-446655440000",
        "comment": "string"
      }
  }
}

const result = await client.callTool({
  "name": "add_comment_to_task",
  "arguments": {
    "taskId": "550e8400-e29b-41d4-a716-446655440000",
    "comment": "string"
  }
});

result = await session.call_tool("add_comment_to_task", arguments={
  "taskId": "550e8400-e29b-41d4-a716-446655440000",
  "comment": "string"
})

Parameters

taskIdstring<uuid>required

The task ID

commentstringrequired

The comment text

add_comment_to_project

Add a comment to a specific project

add_comment_to_project

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "add_comment_to_project",
    "arguments": {
        "projectId": "550e8400-e29b-41d4-a716-446655440000",
        "comment": "string"
      }
  }
}

const result = await client.callTool({
  "name": "add_comment_to_project",
  "arguments": {
    "projectId": "550e8400-e29b-41d4-a716-446655440000",
    "comment": "string"
  }
});

result = await session.call_tool("add_comment_to_project", arguments={
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "comment": "string"
})

Parameters

projectIdstring<uuid>required

The project ID

commentstringrequired

The comment text

add_comment_to_goal

Add a comment to a specific goal

add_comment_to_goal

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "add_comment_to_goal",
    "arguments": {
        "goalId": "550e8400-e29b-41d4-a716-446655440000",
        "comment": "string"
      }
  }
}

const result = await client.callTool({
  "name": "add_comment_to_goal",
  "arguments": {
    "goalId": "550e8400-e29b-41d4-a716-446655440000",
    "comment": "string"
  }
});

result = await session.call_tool("add_comment_to_goal", arguments={
  "goalId": "550e8400-e29b-41d4-a716-446655440000",
  "comment": "string"
})

Parameters

goalIdstring<uuid>required

The goal ID

commentstringrequired

The comment text

search_comments

Search comments by content

search_comments

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "search_comments",
    "arguments": {
        "query": "string",
        "limit": 20,
        "entity": "TASK",
        "employeeId": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "search_comments",
  "arguments": {
    "query": "string",
    "limit": 20,
    "entity": "TASK",
    "employeeId": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("search_comments", arguments={
  "query": "string",
  "limit": 20,
  "entity": "TASK",
  "employeeId": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

querystringrequired

Search query

limitnumber20

Maximum number of results

entitystringTASKPROJECTGOALCANDIDATEDEALINVOICEOTHER

Filter by entity type

employeeIdstring<uuid>

Filter by employee ID

get_recent_comments

Get recent comments for the authenticated user's organization

get_recent_comments

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_recent_comments",
    "arguments": {
        "limit": 20,
        "entity": "TASK",
        "employeeId": "550e8400-e29b-41d4-a716-446655440000",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_recent_comments",
  "arguments": {
    "limit": 20,
    "entity": "TASK",
    "employeeId": "550e8400-e29b-41d4-a716-446655440000",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_recent_comments", arguments={
  "limit": 20,
  "entity": "TASK",
  "employeeId": "550e8400-e29b-41d4-a716-446655440000",
  "relations": [
    "string"
  ]
})

Parameters

limitnumber20

Maximum number of recent comments

entitystringTASKPROJECTGOALCANDIDATEDEALINVOICEOTHER

Filter by entity type

employeeIdstring<uuid>

Filter by employee ID

relationsArray<string>

Relations to include

Stack Overflow Website Demo