update readme for openai playground sample #598
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bpartridge83
suggested changes
May 21, 2025
| * **Authentication Header**: | ||
| * Key: `x-twilio-signature` | ||
| * Value: {Valid Twilio signature} | ||
| ## Generatin Twilio Signature |
There was a problem hiding this comment.
Typo, but I'd recommend:
Generating a Twilio signature
| ℹ️ As the generated signature depends on the full Function endpoint that you are executing, and the URL includes the set of services (e.g. `/mcp?services=PhoneNumbers` vs `/mcp?services=Messaging`), you will need to generate a valid signature every time you update any part of the URL. We recommend dynamically generating the signature whenever you initialize the MCP client configuration with your Twilio MCP server. | ||
| ℹ️ As the generated signature depends on the full Function endpoint that you are executing, and the URL includes the set of services (e.g. `/mcp?services=PhoneNumbers` vs `/mcp?services=Messaging`), you will need to generate a valid signature every time you update any part of the URL. We recommend dynamically generating the signature whenever you initialize the MCP client configuration with your Twilio MCP server. | ||
|
|
||
| ### npx with [`twilio-signature-cli`](https://www.npmjs.com/package/twilio-signature-cli) |
There was a problem hiding this comment.
I had this under JavaScript because of npm; Python and Java and Go developers might not have npm installed. Just like I'd include conda or pip under Python.
|
|
||
| ### OpenAI Playground | ||
|
|
||
| You can use [OpenAI Playground](https://platform.openai.com/playground) to try out the Twilio MCP server. |
There was a problem hiding this comment.
... to try out the your Twilio MCP server... ?
|
|
||
| 1) Follow the instructions here to first deploy your MCP server. | ||
| 2) Visit [OpenAI Playground](https://platform.openai.com/playground) and click on `Create` in front of Tools. Then select `MCP Server` from the dropdown menu. Then select `Add new`. | ||
| 3) Paste the URL of Twilio Functions MCP Server from step 1) in the URL `https://{functions-domain}.twil.io/mcp`. Include any services you want in the query parameter. |
There was a problem hiding this comment.
Paste the URL of (the|your) Twilio Functions MCP server from step 1) ...
|
|
||
| ### Javascript Code Sample | ||
|
|
||
| You can visit and clone https://github.com/twilio-samples/openai-mcp-samples/ for examples of how to use the MCP Server with OpenAI. |
There was a problem hiding this comment.
Visit [our OpenAI MCP samples repo](https://github.com/twilio-samples/openai-mcp-samples/) for examples of...
| You can use [OpenAI Playground](https://platform.openai.com/playground) to try out the Twilio MCP server. | ||
|
|
||
| 1) Follow the instructions here to first deploy your MCP server. | ||
| 2) Visit [OpenAI Playground](https://platform.openai.com/playground) and click on `Create` in front of Tools. Then select `MCP Server` from the dropdown menu. Then select `Add new`. |
There was a problem hiding this comment.
I'd make it Visit the OpenAI Playground and click..., adding "the"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Checklist
npm testlocally and it passed without errors.