Graphql MCP

🚀 GraphQL MCP 服務器

GraphQL MCP 服務器是一個強類型的 TypeScript 模型上下文協議 (MCP) 服務器，藉助 Claude AI 可實現對任何 GraphQL API 的無縫訪問，有效提升代碼質量與類型安全。

🚀 快速開始

GraphQL MCP 服務器能讓你藉助 Claude AI 輕鬆訪問 GraphQL API。以下是使用前的安裝與啟動步驟。

✨ 主要特性

• 強類型：採用 TypeScript 編寫，極大提高代碼質量和類型安全。
• 動態 GraphQL 集成：可與任何 GraphQL API 協同工作，具有高度靈活性。
• 自動發現：能夠自動生成上下文協議 (MCP) 描述，簡化開發流程。
• 命令執行：支持通過 Claude 命令進行查詢和突變操作。
• 可擴展性：易於添加自定義處理邏輯，滿足多樣化需求。

📦 安裝指南

使用以下命令安裝 graphql-mcp-server 包：

npm install graphql-mcp-server --save

💻 使用示例

基礎用法

以下代碼展示瞭如何初始化服務器：

import { MCPGraphQLServer } from 'graphql-mcp-server';

async function start() {
  const server = new MCPGraphQLServer({
    endpoint: 'http://localhost:8080/graphql',
    mcpEndpoint: '/mcp'
  });
  
  await server.start();
  console.log('服務器已啟動');
}
start();

高級用法

以下代碼展示瞭如何添加自定義處理邏輯：

import { MCPGraphQLServer } from 'graphql-mcp-server';

async function start() {
  const server = new MCPGraphQLServer({
    endpoint: 'http://localhost:8080/graphql',
    mcpEndpoint: '/mcp',
    onCommand: async (command) => {
      // 處理自定義命令
      console.log('接收到來自 Claude 的命令:', command);
      return { status: 'success', result: '命令已處理' };
    }
  });
  
  await server.start();
  console.log('服務器已啟動');
}
start();

📚 詳細文檔

• 快速入門指南
• 技術文檔
• 查詢白名單文檔
• 突變文檔
• 項目狀態

🔧 技術細節

開發

若要修改服務器，可按以下步驟操作：

1. 修改 TypeScript 源代碼，文件路徑為 src/graphql-mcp-server.ts。
2. 編譯 TypeScript 代碼，使用命令 npm run build。
3. 運行編譯後的服務器，使用命令 node dist/graphql-mcp-server.js。

發佈到 npm

若要將此包發佈到 npm，可按以下步驟操作：

# 確保你已登錄到 npm
npm login

# 構建項目
npm run build

# 發佈到 npm
npm publish

該包將包含 dist 目錄中的預構建 JavaScript 文件，可直接使用，無需額外的構建步驟。

📄 許可證

此項目根據 Business Source License 1.1 (BSL 1.1) 分發，具體允許情況如下：

• 非商業用途：您可以將此軟件用於任何非商業目的。
• 內部業務用途：您可以將此軟件用於內部業務操作，但不可將其作為託管或管理服務提供給第三方。
• 開源轉換：在 2029 年 3 月 14 日之前，代碼不會自動轉換為 MIT 許可證。

商業用途，包括作為服務提供給他人，需要從 CTK Advisors 獲得商業許可。有關更多信息，請聯繫或查看完整的 LICENSE 文件。

BSL 許可證旨在平衡開源可用性和可持續的商業開發，給予所有人免費訪問非商業用途，同時保護長期維護和改進代碼的能力。