diff --git a/README.md b/README.md index 1a3f328..2203e96 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,14 @@ Let AI operate Gitee repositories/Issues/Pull Requests for you through MCP ## Usage +### Installing via Smithery + +To install Gitee MCP Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@normal-coder/gitee-mcp-server): + +```bash +npx -y @smithery/cli install @normal-coder/gitee-mcp-server --client claude +``` + ### Configuration - `GITEE_API_BASE_URL`: Optional, Gitee OpenAPI Endpoint, default is `https://gitee.com/api/v5` @@ -177,4 +185,4 @@ Licensed under MIT License. You are free to use, modify and distribute the softw ## Related Links - [Model Context Protocol](https://modelcontextprotocol.io) -- [Gitee](https://gitee.com) \ No newline at end of file +- [Gitee](https://gitee.com) diff --git a/smithery.yaml b/smithery.yaml new file mode 100644 index 0000000..91f6526 --- /dev/null +++ b/smithery.yaml @@ -0,0 +1,31 @@ +# Smithery configuration file: https://smithery.ai/docs/config#smitheryyaml + +startCommand: + type: stdio + configSchema: + # JSON Schema defining the configuration options for the MCP. + type: object + required: + - giteePersonalAccessToken + properties: + giteePersonalAccessToken: + type: string + description: Gitee personal access token, required for authentication. + giteeApiBaseUrl: + type: string + default: https://gitee.com/api/v5 + description: Optional Gitee API base URL + commandFunction: + # A JS function that produces the CLI command based on the given config to start the MCP on stdio. + |- + (config) => ({ + command: 'node', + args: ['dist/bin.js'], + env: { + GITEE_PERSONAL_ACCESS_TOKEN: config.giteePersonalAccessToken, + GITEE_API_BASE_URL: config.giteeApiBaseUrl || 'https://gitee.com/api/v5' + } + }) + exampleConfig: + giteePersonalAccessToken: + giteeApiBaseUrl: https://gitee.com/api/v5