Open Context Protocol is live! 🚀 Read the launch post

createInlineComment

Create inline comment

Details

  • Method: POST
  • Path: /inline-comments
  • Operation ID: createInlineComment

Parameters

{
  "blogPostId": {
    "description": "ID of the containing blog post, if intending to create a top level footer comment. Do not provide if creating a reply.",
    "required": false,
    "location": "body",
    "type": "string"
  },
  "pageId": {
    "description": "ID of the containing page, if intending to create a top level footer comment. Do not provide if creating a reply.",
    "required": false,
    "location": "body",
    "type": "string"
  },
  "parentCommentId": {
    "description": "ID of the parent comment, if intending to create a reply. Do not provide if creating a top level comment.",
    "required": false,
    "location": "body",
    "type": "string"
  },
  "body": {
    "description": "",
    "required": false,
    "location": "body",
    "type": "string"
  },
  "inlineCommentProperties": {
    "description": "Object describing the text to highlight on the page/blog post. Only applicable for top level inline comments (not replies) and required in that case.",
    "required": false,
    "location": "body",
    "type": "object"
  }
}

Response Schema

{
  "allOf": [
    {
      "$ref": "#/components/schemas/InlineCommentModel"
    },
    {
      "type": "object",
      "properties": {
        "_links": {
          "type": "object",
          "properties": {
            "base": {
              "type": "string",
              "description": "Base url of the Confluence site."
            }
          }
        }
      }
    }
  ]
}

Usage

from ocp_agent import OCPAgent

agent = OCPAgent()
await agent.register_api('confluence')

# Call this tool
result = await agent.call_tool('createInlineComment', {
    # Add required parameters here
})