Skip to content

Commit 5710576

Browse files
committed
docs: add MCP Server Package section to README with details on usage and versioning
1 parent df32859 commit 5710576

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ If you are looking to integrate file uploads in browsers, use one of our [fronte
1313
## Table of Contents
1414

1515
- [Installation](#installation)
16+
- [MCP Server Package](#mcp-server-package)
1617
- [Usage](#usage)
1718
- [Request & Response types](#request--response-types)
1819
- [File uploads](#file-uploads)
@@ -46,6 +47,16 @@ If you are looking to integrate file uploads in browsers, use one of our [fronte
4647
npm install @imagekit/nodejs
4748
```
4849

50+
## MCP Server Package
51+
52+
This repository also includes a separate **Model Context Protocol (MCP) server** package published as [`@imagekit/api-mcp`](https://www.npmjs.com/package/@imagekit/api-mcp). This MCP server enables AI assistants and agents to interact with the ImageKit API directly.
53+
54+
> **Important Note on Versioning:** The MCP server package (`@imagekit/api-mcp`) is maintained within this monorepo and shares the same version number as the main Node.js SDK. **However, semantic versioning for this repository is determined solely based on changes to the Node.js SDK (`@imagekit/nodejs`).** This means the MCP server package may contain breaking changes in minor or patch releases, as its versioning does not follow independent semantic versioning conventions. If you use the MCP server package, always review the [CHANGELOG](CHANGELOG.md) to understand what has changed before upgrading.
55+
56+
For detailed installation instructions, usage examples, and documentation about the MCP server, please visit:
57+
- **MCP Server Documentation:** [https://imagekit.io/docs/mcp-server](https://imagekit.io/docs/mcp-server)
58+
- **Package README:** [packages/mcp-server/README.md](packages/mcp-server/README.md)
59+
4960
## Usage
5061

5162
The full API of this library can be found in [api.md](api.md).

0 commit comments

Comments
 (0)