← Explore all agents

CHANGELOG EDITING / GitHub partners

Octopus Deploy release notes

Reads the last release deployed to an Octopus project and environment and writes Markdown release notes from its commits.

“Generate release notes for a release in Octopus Deploy. The tools for this MCP server provide access to the Octopus Deploy APIs.”

01 / THE REASONING

Why this made the selection.

  • The Octopus MCP tool list is read-only: every allowed tool is a get_ or list_ call, such as list_releases_for_project and get_release_by_id.
  • It reads each commit's message, author, date and diff, and may skip a commit that is irrelevant to the notes rather than listing every one.

02 / THE REVIEW RECORD

What we actually inspected.

Source review has boundaries.
A clear record is more useful than a “safe” badge.

Material inspected

  • agents/octopus-deploy-release-notes-mcp.agent.md
  • plugins/partners/plugin.json and README.md
  • LICENSE

Our findings

  • Listed in plugins/partners/plugin.json, whose description is Custom agents that have been created by GitHub partners. The commit history was not used to attribute authorship.
  • The notes are a Markdown list summarising the commits in the release build information.

Not established by this review

  • The agent was not run and no Octopus server was connected.
  • @octopusdeploy/mcp-server was not opened.

The review applies to the material and revision named here. A newer upstream release can change its behavior.

03 / PUT IT TO WORK

Use the role in your project.

Upstream setup instructions ↗

DOCUMENTED COMMAND

copilot plugin install partners@awesome-copilot

Copying does not execute this command. It may retrieve a newer version than the reviewed source.

  1. The command installs the partners plugin, which bundles 20 partner agents, not only this one.
  2. For this agent alone, download the unchanged octopus-deploy-release-notes-mcp.agent.md with its LICENSE.txt and place a reviewed copy in the workspace .github/agents/ folder, as the VS Code custom-agent documentation describes.
  3. Store OCTOPUS_API_KEY and OCTOPUS_SERVER_URL as secrets, as the mcp-servers block expects. Use an API key with read access.

Before you start

  • GitHub Copilot with custom agents
  • An Octopus Deploy server and API key
  • Node.js, for the npx MCP server

THE COMPLETE REVIEWED DEFINITION

Read it before you reuse it.

Original source bytes, with attribution.
Review the host-specific setup notes above.

---
name: octopus-release-notes-with-mcp
description: Generate release notes for a release in Octopus Deploy. The tools for this MCP server provide access to the Octopus Deploy APIs.
mcp-servers:
  octopus:
    type: 'local'
    command: 'npx'
    args:
    - '-y'
    - '@octopusdeploy/mcp-server'
    env:
      OCTOPUS_API_KEY: ${{ secrets.OCTOPUS_API_KEY }}
      OCTOPUS_SERVER_URL: ${{ secrets.OCTOPUS_SERVER_URL }}
    tools:
    - 'get_account'
    - 'get_branches'
    - 'get_certificate'
    - 'get_current_user'
    - 'get_deployment_process'
    - 'get_deployment_target'
    - 'get_kubernetes_live_status'
    - 'get_missing_tenant_variables'
    - 'get_release_by_id'
    - 'get_task_by_id'
    - 'get_task_details'
    - 'get_task_raw'
    - 'get_tenant_by_id'
    - 'get_tenant_variables'
    - 'get_variables'
    - 'list_accounts'
    - 'list_certificates'
    - 'list_deployments'
    - 'list_deployment_targets'
    - 'list_environments'
    - 'list_projects'
    - 'list_releases'
    - 'list_releases_for_project'
    - 'list_spaces'
    - 'list_tenants'
---

# Release Notes for Octopus Deploy

You are an expert technical writer who generates release notes for software applications.
You are provided the details of a deployment from Octopus deploy including high level release nots with a list of commits, including their message, author, and date.
You will generate a complete list of release notes based on deployment release and the commits in markdown list format.
You must include the important details, but you can skip a commit that is irrelevant to the release notes.

In Octopus, get the last release deployed to the project, environment, and space specified by the user.
For each Git commit in the Octopus release build information, get the Git commit message, author, date, and diff from GitHub.
Create the release notes in markdown format, summarising the git commits.

The download contains octopus-deploy-release-notes-mcp.agent.md. Keep its filename when placing it in the agent directory described above.

By GitHub partners. Exact upstream source ↗ · Licence · Attribution

SHA-256 8c97c9816b262e767dca8113bd962a290cafaeab3ddd8ba70ccbc730f32fd1ec

Read the applicable licence
MIT License

Copyright GitHub, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

04 / FOLLOW THE EVIDENCE

The source trail.

Our notes are separate from the original resource.
Check upstream before adopting a new version.

  1. Agent definition ↗Checked

    https://github.com/github/awesome-copilot/blob/156736fb63e965b2f547a1460f3b5972c46e6b24/agents/octopus-deploy-release-notes-mcp.agent.md

    Supports: summary, upstreamDescription, whySelected, limitations, access, review

  2. https://github.com/github/awesome-copilot/blob/156736fb63e965b2f547a1460f3b5972c46e6b24/plugins/partners/plugin.json

    Supports: publisher

  3. https://github.com/github/awesome-copilot/blob/156736fb63e965b2f547a1460f3b5972c46e6b24/plugins/partners/README.md

    Supports: install

  4. https://github.com/github/awesome-copilot/blob/156736fb63e965b2f547a1460f3b5972c46e6b24/LICENSE

    Supports: license

  5. https://code.visualstudio.com/docs/copilot/customization/custom-agents

    Supports: install, compatibility

Evidence & Ask