Skip to content

Commit 2bb3f29

Browse files
docs(mcp): improve MCP readme docs (#38)
1 parent db9ceca commit 2bb3f29

File tree

1 file changed

+47
-11
lines changed

1 file changed

+47
-11
lines changed

packages/mcp-server/README.md

Lines changed: 47 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,21 @@ It is generated with [Stainless](https://www.stainless.com/).
44

55
## Installation
66

7-
### Via Claude Desktop
7+
### Direct invocation
88

9-
See [the user guide](https://modelcontextprotocol.io/quickstart/user) for setup.
9+
You can run the MCP Server directly via `npx`:
1010

11-
Once it's set up, find your `claude_desktop_config.json` file:
11+
```sh
12+
export ISAACUS_API_KEY = "My API Key"
13+
npx -y isaacus-mcp
14+
```
1215

13-
- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
14-
- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
16+
### Via MCP Client
1517

16-
Add the following value to your `mcpServers` section. Make sure to provide any necessary environment variables (like API keys) as well.
18+
There is a partial list of existing clients at [modelcontextprotocol.io](https://modelcontextprotocol.io/clients). If you already
19+
have a client, consult their documentation to install the MCP server.
20+
21+
For clients with a configuration JSON, it might look something like this:
1722

1823
```json
1924
{
@@ -41,16 +46,47 @@ You can filter by multiple aspects:
4146
- `--resource` includes all tools under a specific resource, and can have wildcards, e.g. `my.resource*`
4247
- `--operation` includes just read (get/list) or just write operations
4348

44-
See more information with `--help`:
45-
46-
```sh
47-
$ npx -y isaacus-mcp --help
48-
```
49+
See more information with `--help`.
4950

5051
All of these command-line options can be repeated, combined together, and have corresponding exclusion versions (e.g. `--no-tool`).
5152

5253
Use `--list` to see the list of available tools, or see below.
5354

55+
## Importing the tools and server individually
56+
57+
```js
58+
// Import the server, generated endpoints, or the init function
59+
import { server, endpoints, init } from "isaacus-mcp/server";
60+
61+
// import a specific tool
62+
import createClassificationsUniversal from "isaacus-mcp/tools/classifications/universal/create-classifications-universal";
63+
64+
// initialize the server and all endpoints
65+
init({ server, endpoints });
66+
67+
// manually start server
68+
const transport = new StdioServerTransport();
69+
await server.connect(transport);
70+
71+
// or initialize your own server with specific tools
72+
const myServer = new McpServer(...);
73+
74+
// define your own endpoint
75+
const myCustomEndpoint = {
76+
tool: {
77+
name: 'my_custom_tool',
78+
description: 'My custom tool',
79+
inputSchema: zodToJsonSchema(z.object({ a_property: z.string() })),
80+
},
81+
handler: async (client: client, args: any) => {
82+
return { myResponse: 'Hello world!' };
83+
})
84+
};
85+
86+
// initialize the server with your custom endpoints
87+
init({ server: myServer, endpoints: [createClassificationsUniversal, myCustomEndpoint] });
88+
```
89+
5490
## Available Tools
5591

5692
The following tools are available in this MCP server.

0 commit comments

Comments
 (0)