Skip to content

Commit 0bb7359

Browse files
chore(internal): codegen related update
1 parent 9986f65 commit 0bb7359

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
@@ -42,17 +42,18 @@ For clients with a configuration JSON, it might look something like this:
4242

4343
### Cursor
4444

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

48-
[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=@tryfinch/finch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJTZXQgeW91ciBGSU5DSF9BQ0NFU1NfVE9LRU4gaGVyZS4iLCJGSU5DSF9DTElFTlRfSUQiOiJTZXQgeW91ciBGSU5DSF9DTElFTlRfSUQgaGVyZS4iLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiU2V0IHlvdXIgRklOQ0hfQ0xJRU5UX1NFQ1JFVCBoZXJlLiIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiU2V0IHlvdXIgRklOQ0hfV0VCSE9PS19TRUNSRVQgaGVyZS4ifX0)
48+
[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=@tryfinch/finch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJTZXQgeW91ciBGSU5DSF9BQ0NFU1NfVE9LRU4gaGVyZS4iLCJGSU5DSF9DTElFTlRfSUQiOiJTZXQgeW91ciBGSU5DSF9DTElFTlRfSUQgaGVyZS4iLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiU2V0IHlvdXIgRklOQ0hfQ0xJRU5UX1NFQ1JFVCBoZXJlLiIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiU2V0IHlvdXIgRklOQ0hfV0VCSE9PS19TRUNSRVQgaGVyZS4ifX0)
4949

5050
## Exposing endpoints to your MCP Client
5151

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

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

5758
### Filtering endpoints and tools
5859

@@ -87,6 +88,18 @@ All of these command-line options can be repeated, combined together, and have c
8788

8889
Use `--list` to see the list of available tools, or see below.
8990

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

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

0 commit comments

Comments
 (0)