Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 0 additions & 84 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,90 +71,6 @@ yarn add @scalar/sdk zod

> [!NOTE]
> This package is published with CommonJS and ES Modules (ESM) support.


### Model Context Protocol (MCP) Server

This SDK is also an installable MCP server where the various SDK methods are
exposed as tools that can be invoked by AI applications.

> Node.js v20 or greater is required to run the MCP server from npm.

<details>
<summary>Claude installation steps</summary>

Add the following server definition to your `claude_desktop_config.json` file:

```json
{
"mcpServers": {
"Scalar": {
"command": "npx",
"args": [
"-y", "--package", "@scalar/sdk",
"--",
"mcp", "start",
"--bearer-auth", "..."
]
}
}
}
```

</details>

<details>
<summary>Cursor installation steps</summary>

Create a `.cursor/mcp.json` file in your project root with the following content:

```json
{
"mcpServers": {
"Scalar": {
"command": "npx",
"args": [
"-y", "--package", "@scalar/sdk",
"--",
"mcp", "start",
"--bearer-auth", "..."
]
}
}
}
```

</details>

You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:

```bash
curl -L -o mcp-server \
https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-server
```

If the repo is a private repo you must add your Github PAT to download a release `-H "Authorization: Bearer {GITHUB_PAT}"`.


```json
{
"mcpServers": {
"Todos": {
"command": "./DOWNLOAD/PATH/mcp-server",
"args": [
"start"
]
}
}
}
```

For a full list of server arguments, run:

```sh
npx -y --package @scalar/sdk -- mcp start --help
```
<!-- End SDK Installation [installation] -->

<!-- Start Requirements [requirements] -->
Expand Down
16 changes: 1 addition & 15 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
"version": "0.1.0",
"author": "Scalar",
"type": "module",
"bin": {
"mcp": "bin/mcp-server.js"
},
"tshy": {
"sourceDialects": [
"@scalar/sdk/source"
Expand All @@ -24,26 +21,15 @@
"sideEffects": false,
"scripts": {
"lint": "eslint --cache --max-warnings=0 src",
"build:mcp": "bun src/mcp-server/build.mts",
"build": "npm run build:mcp && tshy",
"build": "tshy",
"prepublishOnly": "npm run build"
},
"peerDependencies": {
"@modelcontextprotocol/sdk": ">=1.5.0 <1.10.0",
"zod": ">= 3"
},
"peerDependenciesMeta": {
"@modelcontextprotocol/sdk": {"optional":true}
},
"devDependencies": {
"@eslint/js": "^9.19.0",
"@modelcontextprotocol/sdk": ">=1.5.0 <1.10.0",
"@stricli/core": "^1.1.1",
"@types/express": "^4.17.21",
"bun": "^1.2.2",
"bun-types": "^1.2.2",
"eslint": "^9.19.0",
"express": "^4.21.2",
"globals": "^15.14.0",
"tshy": "^2.0.0",
"typescript": "^5.4.5",
Expand Down