README.md•4.34 kB
# AITable MCP Server
A Model Context Protocol server that provides read and write access to [AITable.ai](https://aitable.ai). This server enables LLMs to list spaces, search nodes, list records, create records and upload attachments in AITable.ai.
<a href="https://glama.ai/mcp/servers/@apitable/aitable-mcp-server">
<img width="380" height="200" src="https://glama.ai/mcp/servers/@apitable/aitable-mcp-server/badge" alt="AITable Server MCP server" />
</a>
## Tools
| Tool Name | Availabe | Description |
| ------------------------- | -------- | ------------------------------------------------------------------------------------------------------------- |
| list_spaces | ✅ | Fetches all workspaces that the currently authenticated user has permission to access. |
| search_nodes | ✅ | Retrieve nodes based on specific types, permissions, and queries. |
| list_records | ✅ | Read the records from a specified database with support for pagination, field filtering, and sorting options. |
| get_fields_schema | ✅ | Returns the JSON schema of all fields within the specified database |
| create_record | ✅ | Create a new record in the database. |
| upload_attachment_via_url | ✅ | Upload an attachment to the AITable server using its web URL. |
| update_record | ❌ | TODO |
## Environment Variables
- `AITABLE_API_KEY`: Your AITable personal access token.
- `AITABLE_BASE_URL`: The base URL of the AITable API. Defaults to `https://aitable.ai/fusion`. You can set it to `{YOUR_CUSTOM_BASE_URL}` if you are using the APITable(the open-source version of AITable).
## Usage
You can use this server in MCP client such as [Claude Desktop](https://claude.ai/download), [CherryStudio](https://www.cherry-ai.com/), etc.
**Claude Desktop**
In the case of Claude Desktop, you need to add the following configuration information to the "mcpServers" section of the `claude_desktop_config.json` file:
For Linux, MacOS:
```json
{
"mcpServers": {
"aitable": {
"command": "npx",
"args": [
"-y",
"/ABSOLUTE/PATH/TO/PARENT/FOLDER/aitable-mcp-server"
],
"env": {
"AITABLE_API_KEY": "YOUR_API_KEY"
}
}
}
}
```
For Windows:
```json
{
"mcpServers": {
"aitable": {
"command": "npx",
"args": [
"-y",
"D:\\ABSOLUTE\\PATH\\TO\\PARENT\\FOLDER\\aitable-mcp-server"
],
"env": {
"AITABLE_API_KEY": "YOUR_API_KEY"
}
}
}
}
```
Replace `YOUR_API_KEY` with your AITable personal access token and `/ABSOLUTE/PATH/TO/PARENT/FOLDER/aitable-mcp-server` with the absolute path to the parent folder of this repository.
**CherryStudio**
If you are using the CherryStudio as MCP client and Windows system, your configuration should look like this:
```json
{
"mcpServers": {
"aitable": {
"command": "cmd",
"args": [
"/c",
"npx",
"-y",
"D:\\ABSOLUTE\\PATH\\TO\\PARENT\\FOLDER\\aitable-mcp-server"
],
"env": {
"AITABLE_API_KEY": "YOUR_API_KEY"
}
}
}
}
```
## Debug
The [MCP inspector](https://github.com/modelcontextprotocol/inspector) is a developer tool for testing and debugging MCP servers.
To inspect an MCP server implementation, there's no need to clone the MCP inspector repo. Instead, use `npx`. For example, AITable MCP server is built at `dist/index.js`. Arguments are passed directly to your server, while environment variables can be set using the `-e` flag:
```bash
npx @modelcontextprotocol/inspector -e AITABLE_API_KEY={YOUR_API_KEY} node build/index.js
```
The other way is to clone the MCP inspector repo and connect the AITable MCP server in the inspector interface.
```bash
cd path/to/inspector/
npm start -- -e AITABLE_API_KEY={YOUR_API_KEY}
```