Open Context Protocol is live! 🚀 Read the launch post

createProject

Create project

Details

  • Method: POST
  • Path: /rest/api/3/project
  • Operation ID: createProject

Parameters

{
  "assigneeType": {
    "description": "The default assignee when creating issues for this project.",
    "required": false,
    "location": "body",
    "type": "string",
    "enum": [
      "PROJECT_LEAD",
      "UNASSIGNED"
    ]
  },
  "avatarId": {
    "description": "An integer value for the project's avatar.",
    "required": false,
    "location": "body",
    "type": "integer"
  },
  "categoryId": {
    "description": "The ID of the project's category. A complete list of category IDs is found using the [Get all project categories](#api-rest-api-3-projectCategory-get) operation.",
    "required": false,
    "location": "body",
    "type": "integer"
  },
  "description": {
    "description": "A brief description of the project.",
    "required": false,
    "location": "body",
    "type": "string"
  },
  "fieldConfigurationScheme": {
    "description": "The ID of the field configuration scheme for the project. Use the [Get all field configuration schemes](#api-rest-api-3-fieldconfigurationscheme-get) operation to get a list of field configuration scheme IDs. If you specify the field configuration scheme you cannot specify the project template key.",
    "required": false,
    "location": "body",
    "type": "integer"
  },
  "issueSecurityScheme": {
    "description": "The ID of the issue security scheme for the project, which enables you to control who can and cannot view issues. Use the [Get issue security schemes](#api-rest-api-3-issuesecurityschemes-get) resource to get all issue security scheme IDs.",
    "required": false,
    "location": "body",
    "type": "integer"
  },
  "issueTypeScheme": {
    "description": "The ID of the issue type scheme for the project. Use the [Get all issue type schemes](#api-rest-api-3-issuetypescheme-get) operation to get a list of issue type scheme IDs. If you specify the issue type scheme you cannot specify the project template key.",
    "required": false,
    "location": "body",
    "type": "integer"
  },
  "issueTypeScreenScheme": {
    "description": "The ID of the issue type screen scheme for the project. Use the [Get all issue type screen schemes](#api-rest-api-3-issuetypescreenscheme-get) operation to get a list of issue type screen scheme IDs. If you specify the issue type screen scheme you cannot specify the project template key.",
    "required": false,
    "location": "body",
    "type": "integer"
  },
  "key": {
    "description": "Project keys must be unique and start with an uppercase letter followed by one or more uppercase alphanumeric characters. The maximum length is 10 characters.",
    "required": true,
    "location": "body",
    "type": "string"
  },
  "lead": {
    "description": "This parameter is deprecated because of privacy changes. Use `leadAccountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. The user name of the project lead. Either `lead` or `leadAccountId` must be set when creating a project. Cannot be provided with `leadAccountId`.",
    "required": false,
    "location": "body",
    "type": "string"
  },
  "leadAccountId": {
    "description": "The account ID of the project lead. Either `lead` or `leadAccountId` must be set when creating a project. Cannot be provided with `lead`.",
    "required": false,
    "location": "body",
    "type": "string"
  },
  "name": {
    "description": "The name of the project.",
    "required": true,
    "location": "body",
    "type": "string"
  },
  "notificationScheme": {
    "description": "The ID of the notification scheme for the project. Use the [Get notification schemes](#api-rest-api-3-notificationscheme-get) resource to get a list of notification scheme IDs.",
    "required": false,
    "location": "body",
    "type": "integer"
  },
  "permissionScheme": {
    "description": "The ID of the permission scheme for the project. Use the [Get all permission schemes](#api-rest-api-3-permissionscheme-get) resource to see a list of all permission scheme IDs.",
    "required": false,
    "location": "body",
    "type": "integer"
  },
  "projectTemplateKey": {
    "description": "A predefined configuration for a project. The type of the `projectTemplateKey` must match with the type of the `projectTypeKey`.",
    "required": false,
    "location": "body",
    "type": "string",
    "enum": [
      "com.pyxis.greenhopper.jira:gh-simplified-agility-kanban",
      "com.pyxis.greenhopper.jira:gh-simplified-agility-scrum",
      "com.pyxis.greenhopper.jira:gh-simplified-basic",
      "com.pyxis.greenhopper.jira:gh-simplified-kanban-classic",
      "com.pyxis.greenhopper.jira:gh-simplified-scrum-classic",
      "com.pyxis.greenhopper.jira:gh-cross-team-template",
      "com.pyxis.greenhopper.jira:gh-cross-team-planning-template",
      "com.atlassian.servicedesk:simplified-it-service-management",
      "com.atlassian.servicedesk:simplified-it-service-management-basic",
      "com.atlassian.servicedesk:simplified-it-service-management-operations",
      "com.atlassian.servicedesk:simplified-general-service-desk",
      "com.atlassian.servicedesk:simplified-internal-service-desk",
      "com.atlassian.servicedesk:simplified-external-service-desk",
      "com.atlassian.servicedesk:simplified-hr-service-desk",
      "com.atlassian.servicedesk:simplified-facilities-service-desk",
      "com.atlassian.servicedesk:simplified-legal-service-desk",
      "com.atlassian.servicedesk:simplified-marketing-service-desk",
      "com.atlassian.servicedesk:simplified-finance-service-desk",
      "com.atlassian.servicedesk:simplified-analytics-service-desk",
      "com.atlassian.servicedesk:simplified-design-service-desk",
      "com.atlassian.servicedesk:simplified-sales-service-desk",
      "com.atlassian.servicedesk:simplified-halp-service-desk",
      "com.atlassian.servicedesk:next-gen-it-service-desk",
      "com.atlassian.servicedesk:next-gen-hr-service-desk",
      "com.atlassian.servicedesk:next-gen-legal-service-desk",
      "com.atlassian.servicedesk:next-gen-marketing-service-desk",
      "com.atlassian.servicedesk:next-gen-facilities-service-desk",
      "com.atlassian.servicedesk:next-gen-general-service-desk",
      "com.atlassian.servicedesk:next-gen-analytics-service-desk",
      "com.atlassian.servicedesk:next-gen-finance-service-desk",
      "com.atlassian.servicedesk:next-gen-design-service-desk",
      "com.atlassian.servicedesk:next-gen-sales-service-desk",
      "com.atlassian.jira-core-project-templates:jira-core-simplified-content-management",
      "com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval",
      "com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking",
      "com.atlassian.jira-core-project-templates:jira-core-simplified-process-control",
      "com.atlassian.jira-core-project-templates:jira-core-simplified-procurement",
      "com.atlassian.jira-core-project-templates:jira-core-simplified-project-management",
      "com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment",
      "com.atlassian.jira-core-project-templates:jira-core-simplified-task-"
    ]
  },
  "projectTypeKey": {
    "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes), which defines the application-specific feature set. If you don't specify the project template you have to specify the project type.",
    "required": false,
    "location": "body",
    "type": "string",
    "enum": [
      "software",
      "service_desk",
      "business"
    ]
  },
  "url": {
    "description": "A link to information about this project, such as project documentation",
    "required": false,
    "location": "body",
    "type": "string"
  },
  "workflowScheme": {
    "description": "The ID of the workflow scheme for the project. Use the [Get all workflow schemes](#api-rest-api-3-workflowscheme-get) operation to get a list of workflow scheme IDs. If you specify the workflow scheme you cannot specify the project template key.",
    "required": false,
    "location": "body",
    "type": "integer"
  }
}

Response Schema

{
  "additionalProperties": false,
  "description": "Identifiers for a project.",
  "properties": {
    "id": {
      "description": "The ID of the created project.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "key": {
      "description": "The key of the created project.",
      "readOnly": true,
      "type": "string"
    },
    "self": {
      "description": "The URL of the created project.",
      "format": "uri",
      "readOnly": true,
      "type": "string"
    }
  },
  "required": [
    "id",
    "key",
    "self"
  ],
  "type": "object"
}

Usage

from ocp_agent import OCPAgent

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

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