Dingtalk

🚀 DingTalk MCP Service

This is a DingTalk service based on MCP (Model Control Protocol), which provides the functionality to access DingTalk APIs.

✨ Features

1. Obtain the DingTalk Access Token.
2. Retrieve the department list.
3. Get the user list of a department.
4. Query user detailed information by name (including traversing departments to find users).

📦 Installation

Prerequisites

• Python 3.12+
• Docker (recommended)
• DingTalk application credentials

Steps

1. Obtain DingTalk Application Credentials

1. Log in to the DingTalk Open Platform.
2. Create an in - house enterprise application.
3. Obtain the AppKey and AppSecret of the application.

2. Configure Environment Variables

You need to set the following environment variables:

DINGDING_APP_KEY=YourAppKey
DINGDING_APP_SECRET=YourAppSecret

💻 Usage Examples

Using in Claude Desktop Client

1. Add the following configuration to your claude_desktop_config.json:

{
  "mcpServers": {
    "dingding": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e", "DINGDING_APP_KEY=YourAppKey",
        "-e", "DINGDING_APP_SECRET=YourAppSecret",
        "ghcr.io/YourUsername/dingding-mcp:latest"
      ]
    }
  }
}

Local Development

1. Clone the repository:

git clone <repository_url>
cd dingding_chat

2. Install dependencies:

pip install -r requirements.txt

3. Run the service:

python src/server.py

Docker Deployment

1. Pull the image:

docker pull ghcr.io/YourUsername/dingding-mcp:latest

2. Run the container:

docker run -d --name dingding-mcp \
  -e DINGDING_APP_KEY=YourAppKey \
  -e DINGDING_APP_SECRET=YourAppSecret \
  ghcr.io/YourUsername/dingding-mcp:latest

📚 Documentation

1. Get Access Token

• Function: Obtain the access token for DingTalk API.
• Tool Name: get_access_token
• Parameters: None
• Return: A string of the access token

2. Get Department List

• Function: Retrieve the department list of the enterprise.
• Tool Name: get_department_list
• Parameters:
  • fetch_child: Whether to fetch the list of child departments (optional, default is true)
• Return: Information about the department list (including department ID, name, parent department ID, etc.)

3. Get Department User List

• Function: Get the user list of a specified department.
• Tool Name: get_department_users
• Parameters:
  • department_id: Department ID (required)
• Return: The user list of the department (including user ID, name, etc.)

4. Query User by Name

• Function: Query user detailed information by user name.
• Tool Name: get_user_by_name
• Parameters:
  • user_name: User name
• Return: User detailed information (including user ID, name, email, etc.)

⚠️ Important Note

1. When configuring DingTalk application credentials, ensure that the AppKey and AppSecret are correct.
2. When using this service to query users, there may be network latency, which depends on the response time of the DingTalk server.
3. It is recommended to use Docker deployment in the production environment to ensure service stability.

📄 License

This project is licensed under the MIT License.