Skip to content

Update btp-integration-suite-mcp-gateway #24238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jung-thomas merged 3 commits into from
Oct 3, 2026
Merged

Update btp-integration-suite-mcp-gateway #24238

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7c0d31b
Update btp-integration-suite-mcp-gateway.md
manouxnam Oct 3, 2026
5a576a9
Update btp-integration-suite-mcp-gateway.md
manouxnam Oct 3, 2026
676d979
Update btp-integration-suite-mcp-gateway.md
manouxnam Oct 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
278 changes: 120 additions & 158 deletions tutorials/btp-integration-suite-mcp-gateway/btp-integration-suite-mcp-gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,174 +110,136 @@ Click on **Add and Open in API Designer**.

Here you need to navigate to the **Code** tab in order to modify your script. Here you can find a downloadable [example OpenAPI Specification](https://github.com/sap-tutorials/Tutorials-Contribution/raw/master/tutorials/btp-integration-suite-mcp-gateway/OpenAPISpecification_Example.yaml).

11. Add the incident operations to your OpenAPI specification.

Your generated spec has an empty `paths: {}` and only `securitySchemes` under `components`. Your server URL, token URLs, and title are already correct — leave them alone. Just make the two edits below (identical for everyone).

Replace `paths: {}` with:

```yaml
paths:
/:
get:
summary: Query incidents
description: Retrieves incidents matching an encoded query
tags: [Incidents]
parameters:
- $ref: '#/components/parameters/SysparmQuery'
- $ref: '#/components/parameters/SysparmLimit'
- $ref: '#/components/parameters/SysparmFields'
- $ref: '#/components/parameters/SysparmDisplayValue'
responses:
'200':
description: List of incidents matching the query
content:
application/json:
schema:
$ref: '#/components/schemas/IncidentListResponse'
'400': { $ref: '#/components/responses/BadRequest' }
'401': { $ref: '#/components/responses/Unauthorized' }
'500': { $ref: '#/components/responses/InternalServerError' }
post:
summary: Create incident
description: Creates a new incident record
tags: [Incidents]
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateIncidentRequest'
responses:
'201':
description: Incident created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/IncidentResponse'
'400': { $ref: '#/components/responses/BadRequest' }
'401': { $ref: '#/components/responses/Unauthorized' }
'500': { $ref: '#/components/responses/InternalServerError' }
'/{sys_id}':
get:
summary: Get incident by sys_id
description: Retrieves a specific incident by its system ID
tags: [Incidents]
parameters:
- $ref: '#/components/parameters/SysId'
responses:
'200':
description: Incident details
content:
application/json:
schema:
$ref: '#/components/schemas/IncidentResponse'
'401': { $ref: '#/components/responses/Unauthorized' }
'404': { $ref: '#/components/responses/NotFound' }
'500': { $ref: '#/components/responses/InternalServerError' }
```

Add these under `components:` (next to your existing `securitySchemes:`). Keep `securitySchemes:` as-is; paste `parameters:`, `schemas:`, and `responses:` at the same indent (2 spaces).

```yaml
parameters:
SysparmQuery:
name: sysparm_query
in: query
required: false
schema: { type: string }
example: number=INC0010002
SysparmLimit:
name: sysparm_limit
in: query
required: false
schema: { type: integer }
example: 100
SysparmFields:
name: sysparm_fields
in: query
required: false
schema: { type: string }
example: 'number,short_description,state'
SysparmDisplayValue:
name: sysparm_display_value
in: query
required: false
schema:
type: string
enum: ['true', 'false', all]
example: 'true'
SysId:
name: sys_id
in: path
10. Add the incident operations to your OpenAPI specification.

Replace the empty `paths` with the incident operations. In the **Code** tab, find the line that reads exactly `paths: {}` and replace it with the block below. Change nothing else — leave your `servers` URL, your `tokenUrl`s, `securitySchemes`, and `security` exactly as Integration Suite generated them, since those are unique to your tenant.

```yaml
paths:
/:
get:
summary: Query incidents
description: Retrieves incidents matching an encoded query
tags: [Incidents]
parameters:
- name: sysparm_query
in: query
required: false
schema: { type: string }
example: number=INC0010002
- name: sysparm_limit
in: query
required: false
schema: { type: integer }
example: 100
- name: sysparm_fields
in: query
required: false
schema: { type: string }
example: 'number,short_description,state'
- name: sysparm_display_value
in: query
required: false
schema:
type: string
enum: ['true', 'false', all]
example: 'true'
responses:
'200':
description: List of incidents matching the query
content:
application/json:
schema:
type: object
properties:
result:
type: array
items:
type: object
properties:
number: { type: string, example: INC0010002 }
short_description: { type: string }
description: { type: string }
state: { type: string, example: '1' }
sys_id: { type: string, example: 46b66a40a9fe198101f243dfbc79033d }
'400': { description: Bad request }
'401': { description: Authentication required }
'500': { description: Internal server error }
post:
summary: Create incident
description: Creates a new incident record
tags: [Incidents]
requestBody:
required: true
schema: { type: string }
example: 46b66a40a9fe198101f243dfbc79033d
schemas:
Incident:
type: object
properties:
number: { type: string, example: INC0010002 }
short_description: { type: string }
description: { type: string }
state: { type: string, example: '1' }
sys_id: { type: string, example: 46b66a40a9fe198101f243dfbc79033d }
IncidentListResponse:
type: object
properties:
result:
type: array
items: { $ref: '#/components/schemas/Incident' }
required: [result]
IncidentResponse:
type: object
properties:
result: { $ref: '#/components/schemas/Incident' }
required: [result]
CreateIncidentRequest:
type: object
properties:
short_description: { type: string }
description: { type: string }
required: [short_description, description]
Error:
type: object
properties:
error: { type: string }
status: { type: string }
required: [error, status]
responses:
BadRequest:
description: Bad request
content:
application/json:
schema: { $ref: '#/components/schemas/Error' }
Unauthorized:
description: Authentication required
content:
application/json:
schema: { $ref: '#/components/schemas/Error' }
NotFound:
description: Incident not found
content:
application/json:
schema: { $ref: '#/components/schemas/Error' }
InternalServerError:
description: Internal server error
content:
application/json:
schema: { $ref: '#/components/schemas/Error' }
```
schema:
type: object
required: [short_description, description]
properties:
short_description: { type: string }
description: { type: string }
responses:
'201':
description: Incident created successfully
content:
application/json:
schema:
type: object
properties:
result:
type: object
properties:
number: { type: string, example: INC0010002 }
short_description: { type: string }
description: { type: string }
state: { type: string, example: '1' }
sys_id: { type: string, example: 46b66a40a9fe198101f243dfbc79033d }
'400': { description: Bad request }
'401': { description: Authentication required }
'500': { description: Internal server error }
'/{sys_id}':
get:
summary: Get incident by sys_id
description: Retrieves a specific incident by its system ID
tags: [Incidents]
parameters:
- name: sys_id
in: path
required: true
schema: { type: string }
example: 46b66a40a9fe198101f243dfbc79033d
responses:
'200':
description: Incident details
content:
application/json:
schema:
type: object
properties:
result:
type: object
properties:
number: { type: string, example: INC0010002 }
short_description: { type: string }
description: { type: string }
state: { type: string, example: '1' }
sys_id: { type: string, example: 46b66a40a9fe198101f243dfbc79033d }
'401': { description: Authentication required }
'404': { description: Incident not found }
'500': { description: Internal server error }
```

After pasting into the API Designer, check that `paths:` sits hard against the left margin and that `components:` still contains only `securitySchemes:`. Then validate at editor.swagger.io, click **Save**

Spaces, not tabs. Then validate at editor.swagger.io and redeploy. Once you have updated your script, click on **Save**.

![picture](config13.png)

13. In order to make your API artifact consumable by an MCP server navigate to the **Policies** tab and select the **Authorization** step within the Policy Model flow. Under **Policy Settings** make sure that you tick the box for **Trust Upstream MCP Authorization**.
11. In order to make your API artifact consumable by an MCP server navigate to the **Policies** tab and select the **Authorization** step within the Policy Model flow. Under **Policy Settings** make sure that you tick the box for **Trust Upstream MCP Authorization**.

![picture](config14.png)

14. And as the final step of this chapter click on **Deploy** in order to leverage your API artifact and transform it into an MCP server.
12. And as the final step of this chapter click on **Deploy** in order to leverage your API artifact and transform it into an MCP server.

![picture](config15.png)

Expand Down
Loading