Skip to content

Docs: add MCP Inspector and desktop-client walkthrough for the demo server #31

@itprodirect

Description

@itprodirect

Objective

Add a hands-on walkthrough that shows users how to inspect and call the sample MCP server from common MCP-capable clients or tools.

Context

Once the repo has a reusable mcp101-server, users need a low-friction way to see what tools the server exposes and how an AI host can call them. This issue should focus on documentation and screenshots/examples, not new server behavior.

Scope

Create a walkthrough such as:

docs/demos/insurance-sales-mcp.md

Include:

  • What the demo proves.
  • How to start the server.
  • How to inspect available tools.
  • Example prompts/questions a user can ask.
  • Expected outputs.
  • Troubleshooting notes for Windows Git Bash, WSL, macOS, and Linux where practical.

Acceptance criteria

  • Walkthrough links from the README.
  • Includes setup/run instructions for the sample server.
  • Includes at least 4 beginner-friendly prompt examples.
  • Includes expected outputs for the sample insurance data.
  • Explains the difference between seeing the server run locally and connecting it to a full AI host.
  • Includes a safety note that this demo uses sample data only.

Non-goals

  • Do not modify the server implementation unless a documentation bug proves a command is wrong.
  • Do not add claims/legal examples.
  • Do not add MCPB packaging.
  • Do not require API keys.

Validation

ruff check .
mypy --strict .
pytest -q

Manual docs validation:

  • Fresh clone/install path works.
  • Commands match the package entry points.
  • Expected outputs match data/insurance_sales.csv.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions