Skip to content

Commit 246f1b1

Browse files
authored
Merge pull request #9 from twilio-labs/fix-readme
fix readme
2 parents df9ee1e + 108e80e commit 246f1b1

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

packages/mcp/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The easiest way to get started is to edit the configuration of your client to po
1313
"twilio": {
1414
"command": "npx",
1515
"args": [
16-
"-y",
16+
"-y",
1717
"@twilio-alpha/mcp",
1818
"YOUR_ACCOUNT_SID/YOUR_API_KEY:YOUR_API_SECRET"
1919
]
@@ -28,17 +28,17 @@ Visit [Twilio API Keys docs](https://www.twilio.com/docs/iam/api-keys) for infor
2828

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

31-
**--services (optional)**
31+
**--services (optional)**
3232

33-
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`.
33+
The name of the services you want to use - this corresponds to the filename https://github.com/twilio/twilio-oai/tree/main/spec/yaml
3434

3535
**--tags (optional)**
3636

3737
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.
3838

3939
## Loading Separate APIs
4040

41-
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.
41+
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.
4242

4343
### Examples: Serverless Tools
4444

@@ -50,11 +50,11 @@ Load all the Serverless API tools.
5050
"twilio": {
5151
"command": "npx",
5252
"args": [
53-
"-y",
53+
"-y",
5454
"@twilio-alpha/mcp",
5555
"YOUR_ACCOUNT_SID/YOUR_API_KEY:YOUR_API_SECRET",
5656
"--services",
57-
"serverless_v1"
57+
"twilio_serverless_v1"
5858
]
5959
}
6060
}
@@ -71,7 +71,7 @@ Load the Incoming Phone Number and the Studio Flows API tools.
7171
"twilio": {
7272
"command": "npx",
7373
"args": [
74-
"-y",
74+
"-y",
7575
"@twilio-alpha/mcp",
7676
"YOUR_ACCOUNT_SID/YOUR_API_KEY:YOUR_API_SECRET",
7777
"--tags",
@@ -208,4 +208,4 @@ The following tags can be used with the `--tags` parameter to select specific AP
208208
- `TaskrouterV1Workspace` - Workspace Management
209209
- `TaskrouterV1WorkspaceStatistics` - Workspace Statistics
210210

211-
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.
211+
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.

packages/openapi-mcp-server/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ You can pass the following optional parameters to the `mcp` server:
3535

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

38-
**--services (optional)**
38+
**--services (optional)**
3939

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

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

5050
```ts
51-
class CustomOpenAPIServer extends {
51+
class CustomOpenAPIServer extends OpenAPIMCPServer {
5252
constructor(config: ExtendedConfiguration) {
5353
super({
5454
// these are required
5555
server: config.server,
5656
openAPIDir: '/path/to/openapi/yaml',
57-
57+
5858
// These are optional
5959
filters: config.filters,
6060
authorization: {
@@ -63,7 +63,7 @@ class CustomOpenAPIServer extends {
6363
password: config.credentials.apiSecret,
6464
},
6565
});
66-
66+
6767
// perform any other option
6868
}
6969
}
@@ -99,4 +99,4 @@ If you prefer to play around with the server, you can clone the repository and r
9999
}
100100
}
101101
}
102-
```
102+
```

0 commit comments

Comments
 (0)