Skip to content

docs(readme): rewrite heading + replace pre-publish PyPI badges#32

Merged
arnav2 merged 1 commit into
mainfrom
chore/readme-heading-and-badges
Apr 29, 2026
Merged

docs(readme): rewrite heading + replace pre-publish PyPI badges#32
arnav2 merged 1 commit into
mainfrom
chore/readme-heading-and-badges

Conversation

@arnav2
Copy link
Copy Markdown
Contributor

@arnav2 arnav2 commented Apr 29, 2026

The PyPI / pyversions shields.io badges were rendering red ("package or version not found") because knowledgestack-mcp isn't on PyPI yet — the red badges read like CI failures and undercut first-impressions on the repo page. Replaced with a static "PyPI: coming soon" badge and a static Python 3.11+ badge until the first publish flips them green.

Heading: bigger centered tagline ("One MCP server. Every agent framework. Grounded answers in seconds."), description below it, then a centered "works out of the box with …" framework list. Reads like a landing page rather than a requirements.txt.

CI is unaffected; this is purely cosmetic.

Summary

Type of change

  • 🐛 Bug fix
  • ✨ New tool
  • 🔌 Transport / auth change
  • 📖 Documentation
  • 🧰 Tooling / CI
  • 🧹 Refactor
  • 💥 Breaking change (describe migration in "Notes")

Related issues

Test plan

  • make lint / uv run ruff check .
  • uv run --extra dev pytest tests/ -v green
  • Manually verified with the MCP Inspector (npx @modelcontextprotocol/inspector uvx knowledgestack-mcp) if the change touches tool behavior
  • No secrets, PII, or tenant data in logs

Checklist

  • No API keys in the diff
  • Tool descriptions are clear and complete
  • Read-only contract preserved (no write operations introduced without explicit discussion)
  • Updated mcp-python README if the tool surface changed

Notes

The PyPI / pyversions shields.io badges were rendering red ("package or
version not found") because `knowledgestack-mcp` isn't on PyPI yet — the
red badges read like CI failures and undercut first-impressions on the
repo page. Replaced with a static "PyPI: coming soon" badge and a static
Python 3.11+ badge until the first publish flips them green.

Heading: bigger centered tagline ("One MCP server. Every agent framework.
Grounded answers in seconds."), description below it, then a centered
"works out of the box with …" framework list. Reads like a landing page
rather than a requirements.txt.

CI is unaffected; this is purely cosmetic.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@arnav2 arnav2 requested a review from a team as a code owner April 29, 2026 01:14
@arnav2 arnav2 merged commit c0e154b into main Apr 29, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant