简体中文连接指南

项目配置与运行

项目结构

1. 项目文件：

   • jama_mcp_server/server.py：主服务模块，负责处理Jama Connect的相关操作。
   • test_mcp_client.py：测试客户端脚本，用于直接调用服务器工具进行调试。

2. 运行环境：

   • 确保安装了必要的依赖项（如Python和uv）。
   • 配置项目所需的环境变量。

服务运行

直接运行

在终端中执行以下命令启动服务：

# 切换到jama-mcp-server目录
uv run python -m jama_mcp_server.server

Docker配置

使用Docker运行服务时，可以参考以下JSON配置示例（mcp_settings.json）：

{
  "mcpServers": {
    "jama-mcp": {
      "command": "docker",
      "args": ["run", "--rm", "-i",
        "-e", "JAMA_URL", "-e", "JAMA_CLIENT_ID", "-e", "JAMA_CLIENT_SECRET", "-e", "JAMA_MOCK_MODE",
        "jama-mcp-server"
      ],
      "env": {
        "JAMA_URL": "https://your-jama-instance.com",
        "JAMA_CLIENT_ID": "your-client-id",
        "JAMA_CLIENT_SECRET": ""
      }
    },
  }
}

环境变量配置

必要环境变量

• JAMA_URL：Jama Connect实例的URL地址。
• JAMA_CLIENT_ID 和 JAMA_CLIENT_SECRET：用于身份验证的客户端ID和密钥。

可选环境变量

• JAMA_AWS_SECRET_PATH：如果使用AWS参数存储，指定秘密路径。
• JAMA_AWS_PROFILE：指定使用的AWS配置文件名称。
• JAMA_MOCK_MODE：设置为true启用模拟模式（默认禁用）。

服务启动示例

使用uv命令运行服务时的示例JSON配置：

{
  "mcpServers": {
    "jama-mcp": {
      "command": "uv",
      "args": [
        "run",
        "python",
        "-m",
        "jama_mcp_server.server"
      ],
      
      "cwd": "/path/to/your/clone/jama-mcp-server",
      "env": {
        "JAMA_URL": "https://your.jama.instance.com",
        "JAMA_CLIENT_ID": "your_client_id",
        "JAMA_CLIENT_SECRET": "your_client_secret",
        "JAMA_AWS_SECRET_PATH": "/path/to/your/jama/secret",
        "JAMA_AWS_PROFILE": "your-aws-profile-name",
        "JAMA_MOCK_MODE": "false"
      }
    }
  }
}

测试脚本使用

运行测试客户端：

# 切换到jama-mcp-server目录
uv run python test_mcp_client.py

该脚本会启动服务器并调用预定义的工具进行测试，包括成功和预期失败案例。输出结果后还会提供总结。

可用工具

此服务提供了多种只读工具，具体功能请参考 MCP 客户端界面或相关文档。

故障排除

常见问题

1. 环境变量未配置：

   • 检查是否正确设置了JAMA_URL、JAMA_CLIENT_ID和JAMA_CLIENT_SECRET。

2. Docker运行失败：

   • 确保已安装并启用了 Docker 服务。
   • 检查是否有足够的权限运行容器。

3. 模拟模式未生效：

   • 确认JAMA_MOCK_MODE是否设置为true。

解决方法

1. 验证环境变量：

   echo $JAMA_URL
   echo $JAMA_CLIENT_ID
   echo $JAMA_CLIENT_SECRET
   

2. 检查日志输出：

   • 查看服务启动时的详细日志，确认是否有错误信息。

3. 重新配置环境变量：

   export JAMA_MOCK_MODE=true
   uv run python -m jama_mcp_server.server
   

项目许可

本项目的使用和分发需遵循项目许可证的条款。

如有任何问题或建议，请联系维护团队。