Skip to content

Refactor: Add installation, tutorial, and usage documentation for ros-mcp installed through pip #139

@stex2005

Description

@stex2005

Overview

Add comprehensive documentation covering installation, tutorial, and usage of ros-mcp installed through pip, including:

Installation

  • Instructions for installing ros-mcp using pip:
    pip install .

Usage

  • Example command to run ros-mcp with HTTP transport:
    ros-mcp --transport=http

Integration with LLM client

  • Document integration steps using mcp.json configuration for connecting LLM clients.
  • Provide example and explanation for configuring and using the LLM client with ros-mcp through mcp.json.
"ros-mcp-server-pip": {
      "name": "ROS-MCP Server (pip)",
      "transport": "stdio",
      "command": "wsl",
      "args": [
        "-d", "Ubuntu",
        "bash", "-l", "-c", "cd /mnt/c/Users/sd37989/ros-mcp-server && ros-mcp --transport=stdio"
      ]
    }

Needs the -l, which loads the full environment, finds ros-mcp
Needs cd to local path to have access to utils folder

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomersrefactorRefactoring the repository

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions