Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 8 additions & 8 deletions packages/mcp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The easiest way to get started is to edit the configuration of your client to po
"twilio": {
"command": "npx",
"args": [
"-y",
"-y",
"@twilio-alpha/mcp",
"YOUR_ACCOUNT_SID/YOUR_API_KEY:YOUR_API_SECRET"
]
Expand All @@ -28,17 +28,17 @@ Visit [Twilio API Keys docs](https://www.twilio.com/docs/iam/api-keys) for infor

You can pass the following optional parameters to the `mcp` server:

**--services (optional)**
**--services (optional)**

The name of the services you want to use - this corresponds to the filename https://github.com/twilio/twilio-oai/tree/main/spec/yaml without the `twilio_` prefix - for example `chat_v3` for `twilio_chat_v3`.
The name of the services you want to use - this corresponds to the filename https://github.com/twilio/twilio-oai/tree/main/spec/yaml

**--tags (optional)**

The tag name as defined in each of the individual endpoints. If you want to filter by `tags` only, make sure you pass `--services ''` as an empty object.

## Loading Separate APIs

Due to the context size limitation of LLMs and the vast number of APIs available, you need to load separate APIs by passing the `--services/--tags` parameter. For example, to load the `chat_v3` API, you can pass `--services chat_v3`. If you need particular APIs from separate service files, you can use the `--tags` to individually select the endpoints.
Due to the context size limitation of LLMs and the vast number of APIs available, you need to load separate APIs by passing the `--services/--tags` parameter. For example, to load the `chat_v3` API, you can pass `--services chat_v3`. If you need particular APIs from separate service files, you can use the `--tags` to individually select the endpoints.

### Examples: Serverless Tools

Expand All @@ -50,11 +50,11 @@ Load all the Serverless API tools.
"twilio": {
"command": "npx",
"args": [
"-y",
"-y",
"@twilio-alpha/mcp",
"YOUR_ACCOUNT_SID/YOUR_API_KEY:YOUR_API_SECRET",
"--services",
"serverless_v1"
"twilio_serverless_v1"
]
}
}
Expand All @@ -71,7 +71,7 @@ Load the Incoming Phone Number and the Studio Flows API tools.
"twilio": {
"command": "npx",
"args": [
"-y",
"-y",
"@twilio-alpha/mcp",
"YOUR_ACCOUNT_SID/YOUR_API_KEY:YOUR_API_SECRET",
"--tags",
Expand Down Expand Up @@ -208,4 +208,4 @@ The following tags can be used with the `--tags` parameter to select specific AP
- `TaskrouterV1Workspace` - Workspace Management
- `TaskrouterV1WorkspaceStatistics` - Workspace Statistics

This list includes the most commonly used tags. Each service has its own set of tags that follow the pattern `{ServiceName}{Version}{Resource}`. You can combine multiple tags by separating them with commas in your configuration.
This list includes the most commonly used tags. Each service has its own set of tags that follow the pattern `{ServiceName}{Version}{Resource}`. You can combine multiple tags by separating them with commas in your configuration.
10 changes: 5 additions & 5 deletions packages/openapi-mcp-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ You can pass the following optional parameters to the `mcp` server:

If provided, the username/password will be used as basic-auth authentication with the API calls.

**--services (optional)**
**--services (optional)**

The name of the services you want to use - this corresponds to the individual filename inside the directory of your OpenAPI yaml files.

Expand All @@ -48,13 +48,13 @@ The tag name as defined in each of the individual endpoints. If you want to filt
If you require more control over the server, you can extend `OpenAPIMCPServer`:

```ts
class CustomOpenAPIServer extends {
class CustomOpenAPIServer extends OpenAPIMCPServer {
constructor(config: ExtendedConfiguration) {
super({
// these are required
server: config.server,
openAPIDir: '/path/to/openapi/yaml',

// These are optional
filters: config.filters,
authorization: {
Expand All @@ -63,7 +63,7 @@ class CustomOpenAPIServer extends {
password: config.credentials.apiSecret,
},
});

// perform any other option
}
}
Expand Down Expand Up @@ -99,4 +99,4 @@ If you prefer to play around with the server, you can clone the repository and r
}
}
}
```
```