Skip to content

Commit 8c9026a

Browse files
chore(internal): codegen related update
1 parent a7575d3 commit 8c9026a

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

packages/mcp-server/README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,17 +38,18 @@ For clients with a configuration JSON, it might look something like this:
3838

3939
### Cursor
4040

41-
If you use Cursor, you can install the MCP server by using the button below. You will need to set your environment variables
42-
in Cursor's `mcp.json`, which can be found in Cursor Settings > Tools & MCP > New MCP Server.
41+
If you use Cursor, you can install the MCP server by using the button below. You will need to set your environment variables
42+
in Cursor's `mcp.json`, which can be found in Cursor Settings > Tools & MCP > New MCP Server.
4343

44-
[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=@imagekit/api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBpbWFnZWtpdC9hcGktbWNwIl0sImVudiI6eyJJTUFHRUtJVF9QUklWQVRFX0tFWSI6IlNldCB5b3VyIElNQUdFS0lUX1BSSVZBVEVfS0VZIGhlcmUuIiwiT1BUSU9OQUxfSU1BR0VLSVRfSUdOT1JFU19USElTIjoiU2V0IHlvdXIgT1BUSU9OQUxfSU1BR0VLSVRfSUdOT1JFU19USElTIGhlcmUuIiwiSU1BR0VLSVRfV0VCSE9PS19TRUNSRVQiOiJTZXQgeW91ciBJTUFHRUtJVF9XRUJIT09LX1NFQ1JFVCBoZXJlLiJ9fQ)
44+
[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=@imagekit/api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBpbWFnZWtpdC9hcGktbWNwIl0sImVudiI6eyJJTUFHRUtJVF9QUklWQVRFX0tFWSI6IlNldCB5b3VyIElNQUdFS0lUX1BSSVZBVEVfS0VZIGhlcmUuIiwiT1BUSU9OQUxfSU1BR0VLSVRfSUdOT1JFU19USElTIjoiU2V0IHlvdXIgT1BUSU9OQUxfSU1BR0VLSVRfSUdOT1JFU19USElTIGhlcmUuIiwiSU1BR0VLSVRfV0VCSE9PS19TRUNSRVQiOiJTZXQgeW91ciBJTUFHRUtJVF9XRUJIT09LX1NFQ1JFVCBoZXJlLiJ9fQ)
4545

4646
## Exposing endpoints to your MCP Client
4747

48-
There are two ways to expose endpoints as tools in the MCP server:
48+
There are three ways to expose endpoints as tools in the MCP server:
4949

5050
1. Exposing one tool per endpoint, and filtering as necessary
5151
2. Exposing a set of tools to dynamically discover and invoke endpoints from the API
52+
3. Exposing a docs search tool and a code execution tool, allowing the client to write code to be executed against the TypeScript client
5253

5354
### Filtering endpoints and tools
5455

@@ -83,6 +84,18 @@ All of these command-line options can be repeated, combined together, and have c
8384

8485
Use `--list` to see the list of available tools, or see below.
8586

87+
### Code execution
88+
89+
If you specify `--tools=code` to the MCP server, it will expose just two tools:
90+
91+
- `search_docs` - Searches the API documentation and returns a list of markdown results
92+
- `execute` - Runs code against the TypeScript client
93+
94+
This allows the LLM to implement more complex logic by chaining together many API calls without loading
95+
intermediary results into its context window.
96+
97+
The code execution itself happens in a Deno sandbox that has network access only to the base URL for the API.
98+
8699
### Specifying the MCP Client
87100

88101
Different clients have varying abilities to handle arbitrary tools and schemas.

0 commit comments

Comments
 (0)