Smar MCP

🚀 Smart MCP Server: Smartsheet Integration

This project offers a smart Minimum Viable Product (MCP) server for integrating with Smartsheet and supporting interactions via Claude for Desktop. Here are the detailed project details:

🚀 Quick Start

Getting Started

1. Configure Environment Variables

   • Set the SMARTSHEET_API_KEY environment variable for Smartsheet API authentication.
   • Optional: Set ALLOW_DELETE_TOOLS to 'true' to enable delete operations (disabled by default).

2. Install Dependencies

   npm install
   

3. Run the Development Environment

   npm run dev
   

4. Test the Integration

   • Refer to Claude Desktop Quickstart for local testing.
   • Use claude_desktop_config-example.json as a configuration template and adjust the environment variables as needed.

✨ Features

Core Features

1. Direct API Access: Operate on Smartsheet through the Smartsheet direct API client.
2. Tool Definition: Define MCP tools in src/index.ts, supporting various operations such as creating, reading, updating, and deleting data.
3. Utility Functions: Provide helper functions for common operations to simplify the development process.

Supported Operations

• Create/Read/Update/Delete (CRUD): Perform CRUD operations on Smartsheet projects, tasks, comments, etc.
• Complex Workflows: Implement complex business logic and automated workflows.
• Data Export and Import: Support batch data export and import functions.

📦 Installation

The installation steps are included in the "Quick Start" section.

💻 Usage Examples

Basic Usage

import { SmartsheetClient } from './src/smartsheet-direct-api';

const client = new SmartsheetClient(process.env.SMARTSHEET_API_KEY);

async function createProject() {
  const projectId = await client.createProject('My New Project');
  console.log(`Project created with ID: ${projectId}`);
}

createProject();

📚 Documentation

Documentation Resources

• Official Documentation: Smartsheet API Documentation
• Project Wiki: Check the internal Wiki for more development information.
• Example Repository: Refer to the example code in the examples/ folder.

🔧 Contribution Guidelines

Commit Specification

Follow the Conventional Commits specification with the following format:

<type>(<scope>): <description>

[optional body]

[optional footer(s)]

Type Definitions

• feat: New feature (increment the major version number)
• fix: Bug fix (increment the patch version number)
• docs: Documentation update
• style: Code format adjustment
• refactor: Code refactoring without new features or bug fixes
• perf: Performance optimization
• test: Add/modify test cases
• chore: Adjustment of build tools or other auxiliary tasks

Breaking Changes

Mark breaking changes by adding BREAKING CHANGE: to the commit message or appending ! after the type, for example:

feat!: Remove obsolete API interfaces

Development Process

1. Fork the Repository
2. Create a Feature Branch (git checkout -b feature/amazing-feature)
3. Commit Code: Make commits following the commit specification.
4. Submit a PR: Submit a pull request to the main branch with detailed descriptions.

📄 License

This project is open - sourced under the MIT License. The specific content is as follows:

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

With the above instructions, you can easily get started and use the Smartsheet MCP server for development and integration.