An open API service indexing awesome lists of open source software.

https://github.com/twilio-labs/mcp

Monorepo providing 1) OpenAPI to MCP Tool generator 2) Exposing all of Twilio's API as MCP Tools
https://github.com/twilio-labs/mcp

ai mcp openapi openapi-generator openapi3 twilio-api twilio-mcp

Last synced: 11 days ago
JSON representation

Monorepo providing 1) OpenAPI to MCP Tool generator 2) Exposing all of Twilio's API as MCP Tools

Awesome Lists containing this project

README

        

Twilio AlphaTwilio Alpha


Twilio MCP Monorepo

This is a monorepo for the Model Context Protocol server that exposes all of Twilio APIs.

## What is MCP?

The Model Context Protocol (MCP) is a protocol for exchanging model context information between AI tools and services. This implementation allows you to expose Twilio's APIs to AI assistants and other tools that support the MCP protocol.

## Packages

This monorepo contains two main packages:

- [mcp](/packages/mcp) - MCP Server for all of Twilio's Public API
- [openapi-mcp-server](/packages/openapi-mcp-server) - An MCP server that serves the given OpenAPI spec

Each package has its own comprehensive README with detailed documentation:

- [MCP Package Documentation](/packages/mcp/README.md)
- [OpenAPI MCP Server Documentation](/packages/openapi-mcp-server/README.md)

## Quick Start

The easiest way to get started is by using npx:

```json
{
"mcpServers": {
"twilio": {
"command": "npx",
"args": [
"-y",
"@twilio-alpha/mcp",
"YOUR_ACCOUNT_SID/YOUR_API_KEY:YOUR_API_SECRET"
]
}
}
}
```

Visit [Twilio API Keys docs](https://www.twilio.com/docs/iam/api-keys) for information on how to find/create your API Key and Secret.

## Basic Configuration Options

Both packages accept configuration parameters. Here's a brief overview:

- **MCP Server**: Use `--services` and `--tags` to filter which APIs to expose
- **OpenAPI MCP Server**: Use `--apiPath` to specify OpenAPI spec files location

For complete configuration details, refer to the package-specific documentation linked above.

## Development

```bash
# Run tests
npm test

# Run linting
npm run lint

# Fix linting issues
npm run lint:fix
```

## Troubleshooting Common Issues

- **Context Size Limitations**: Due to LLM context limits, load specific APIs using `--services` or `--tags`
- **Authentication Issues**: Verify your Twilio API credentials format and permissions
- **API Versioning**: Check you're using the correct API version (v1, v2, v3) for your needs

For detailed troubleshooting guidance, see the package-specific documentation.

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

This project is licensed under the ISC License - see the LICENSE file for details.