Class McpConfig

Object-oriented interface for working with MCP Configs.

Remarks

Overview

The McpConfig class provides a high-level, object-oriented API for managing MCP configurations. MCP configs define how to connect to upstream MCP (Model Context Protocol) servers, specifying the target endpoint and which tools are allowed. They can be used with devboxes to securely connect to MCP servers.

Quickstart

import { RunloopSDK } from '@runloop/api-client-ts';

const runloop = new RunloopSDK();
const mcpConfig = await runloop.mcpConfig.create({
  name: 'my-mcp-server',
  endpoint: 'https://mcp.example.com',
  allowed_tools: ['*'],
});

const info = await mcpConfig.getInfo();
console.log(`MCP Config: ${info.name}`);

Index

Accessors

Methods

getInfo update

Accessors

id

get id(): string
Get the MCP config ID.

Returns string
The MCP config ID
- Defined in src/sdk/mcp-config.ts:102

Methods

getInfo

getInfo(options?: RequestOptions<unknown>): Promise<Runloop.McpConfigView>
Get the complete MCP config data from the API.
Parameters
- Optionaloptions: RequestOptions<unknown>
  Request options
Returns Promise<Runloop.McpConfigView>
The MCP config data
Example
```
const info = await mcpConfig.getInfo();
console.log(`MCP Config: ${info.name}, endpoint: ${info.endpoint}`);
```
- Defined in src/sdk/mcp-config.ts:118

update

update(
params: Runloop.McpConfigUpdateParams,
options?: RequestOptions<unknown>,
): Promise<Runloop.McpConfigView>
Update an existing McpConfig. All fields are optional.
Parameters
- params: Runloop.McpConfigUpdateParams
  Parameters for updating the MCP config
- Optionaloptions: RequestOptions<unknown>
  Request options
Returns Promise<Runloop.McpConfigView>
The updated MCP config data
Example
```
const updated = await mcpConfig.update({
  name: 'updated-mcp-name',
  description: 'Updated description',
});
```
- Defined in src/sdk/mcp-config.ts:137

Class McpConfig

Remarks

Overview

Quickstart

Index

Accessors

Methods

Accessors

id

Returns string

Methods

getInfo

Parameters

Returns Promise<Runloop.McpConfigView>

Example

update

Parameters

Returns Promise<Runloop.McpConfigView>

Example

Settings

On This Page