Skip to content

Commit 6e8664d

Browse files
committed
Add API workflow features description in the introduction paragraph
Few adjustements on bump-sh#814
1 parent 541d8e5 commit 6e8664d

1 file changed

Lines changed: 16 additions & 7 deletions

File tree

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,19 @@
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+
2125
[![Version](https://img.shields.io/npm/v/bump-cli.svg)](https://npmjs.org/package/bump-cli)
2226
[![Tests](https://github.com/bump-sh/cli/actions/workflows/checks.yml/badge.svg)](https://github.com/bump-sh/cli/actions/workflows/checks.yml)
2327
[![License](https://img.shields.io/npm/l/bump-cli.svg)](https://github.com/bump-sh/cli/blob/master/package.json)
@@ -177,9 +181,13 @@ Please check `bump deploy --help` for more usage details.
177181

178182
#### Deploy a workflow document on your MCP server
179183

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

184192

185193
```shell
@@ -189,7 +197,8 @@ bump deploy path/to/flower-or-arazzo-document.yml --mcp-server my-mcp-server-id-
189197
> [!NOTE]
190198
> 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'.
191199
192-
More details about the MCP server feature are available on [this dedicated help section](https://docs.bump.sh/help/mcp-servers/).
200+
More details about the MCP server feature are available on [this
201+
dedicated help section](https://docs.bump.sh/help/mcp-servers/).
193202

194203
This feature is currently in closed beta.
195204
Request an early access at hello@bump.sh

0 commit comments

Comments
 (0)