Skip to content

Commit 3500560

Browse files
Polo2paulRbr
andcommitted
Readme: Mention arazzo, and add links to help center
Add API workflow features description in the introduction paragraph Have fun ! Stay kind, Stay free. -- Co-authored-by: Paul B. <paulr@bump.sh>
1 parent 94b2b6a commit 3500560

1 file changed

Lines changed: 21 additions & 5 deletions

File tree

README.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,21 @@
99
<a href="https://bump.sh/users/sign_up">Sign up</a>
1010
</p>
1111

12-
The Bump.sh CLI is used to interact with API documentation and hubs hosted on Bump.sh from your choice of popular API description formats: OpenAPI, Swagger, or AsyncAPI.
12+
The Bump.sh CLI is used to interact with API documentation, hubs and workflows hosted on Bump.sh from your choice of popular API description formats: OpenAPI, Swagger, or AsyncAPI for API documentation. Flower or Arazzo for API workflows.
1313

1414
Using [OpenAPI](https://github.com/OAI/OpenAPI-Specification) (v3.x and v2.0) or [AsyncAPI](https://www.asyncapi.com/docs/reference/specification/latest) (2.x), you can do any of the following:
1515

1616
- Validate an API document before publishing to your documentation.
17-
- Publish an API document to your Bump.sh documentation or hubs.
18-
- Compare two API documents to generate a human-readable diff from your API definition.
17+
- [Publish an API document](#the-deploy-command) to your Bump.sh documentation or hubs.
18+
- [Compare two API documents](#the-diff-command) to generate a human-readable diff from your API definition.
1919
Under the hood, it uses the API of [developers.bump.sh](https://developers.bump.sh). And is built with the [`oclif`](https://oclif.io) framework in Typescript.
2020

21+
Using [Flower](https://docs.bump.sh/help/mcp-servers/specification-support/flower-support/) or [Arazzo](https://docs.bump.sh/arazzo/v1.0/), you can:
22+
23+
- [Deploy a workflow document](#deploy-a-workflow-document-on-your-mcp-server) to your Bump.sh MCP server
24+
25+
Have fun designing APIs ✨.
26+
2127
[![Version](https://img.shields.io/npm/v/bump-cli.svg)](https://npmjs.org/package/bump-cli)
2228
[![Tests](https://github.com/bump-sh/cli/actions/workflows/checks.yml/badge.svg)](https://github.com/bump-sh/cli/actions/workflows/checks.yml)
2329
[![License](https://img.shields.io/npm/l/bump-cli.svg)](https://github.com/bump-sh/cli/blob/master/package.json)
@@ -177,15 +183,25 @@ Please check `bump deploy --help` for more usage details.
177183

178184
#### Deploy a workflow document on your MCP server
179185

180-
Use the `bump deploy` command with the `--mcp-server` flag to push a workflow definition to your MCP server.
186+
Use the `bump deploy` command with the `--mcp-server` flag to push a
187+
workflow definition to your MCP server.
188+
189+
Documents following either [Arazzo](https://docs.bump.sh/arazzo/v1.0/)
190+
or
191+
[Flower](https://docs.bump.sh/help/mcp-servers/specification-support/flower-support/)
192+
specification are supported.
193+
181194

182195
```shell
183-
bump deploy path/to/flower-document.yml --mcp-server my-mcp-server-id-or-slug --token $BUMP_TOKEN
196+
bump deploy path/to/flower-or-arazzo-document.yml --mcp-server my-mcp-server-id-or-slug --token $BUMP_TOKEN
184197
```
185198

186199
> [!NOTE]
187200
> You can find your own `mcp-server-id-or-slug` and `$BUMP_TOKEN` api key from your [MCP server settings](https://bump.sh/dashboard) at 'https://bump.sh/{your-organization}/workflow/set/{mcp-server-id}/tokens'.
188201
202+
More details about the MCP server feature are available on [this
203+
dedicated help section](https://docs.bump.sh/help/mcp-servers/).
204+
189205
This feature is currently in closed beta.
190206
Request an early access at hello@bump.sh
191207

0 commit comments

Comments
 (0)