Skip to content

Add LICENSE, AGENTS.md, smithery.yaml, English README intro#1

Merged
shuakami merged 1 commit into
mainfrom
devin/1778038139-license-agents-smithery-readme
May 6, 2026
Merged

Add LICENSE, AGENTS.md, smithery.yaml, English README intro#1
shuakami merged 1 commit into
mainfrom
devin/1778038139-license-agents-smithery-readme

Conversation

@shuakami
Copy link
Copy Markdown
Member

@shuakami shuakami commented May 6, 2026

Summary

Make uapi-mcp ready to land on the public MCP registries (Smithery, mcphub.io, mcp.run) and easier to consume from any AI agent.

  • LICENSE (MIT)
  • AGENTS.md — dedicated agent-facing playbook (hosted endpoint, npm/stdio install, per-agent wiring, tool overview, auth, rate limits)
  • smithery.yaml + Dockerfile so smithery.ai can deploy the published npm package directly
  • README.md prepends an English summary with badges and a wiring matrix; existing 中文 docs are preserved below
  • package.json: real English description, homepage https://uapis.cn/mcp, MIT license, npm-search-friendly keywords
  • manifest.json: matching keywords/description so MCP registry crawlers see the same metadata

Review & Testing Checklist for Human

  • npm pack still produces a runnable tarball (no missing files)
  • npm publish for 0.1.2 picks up the new metadata (description, keywords, license, homepage)
  • Smithery deploy: point smithery.ai at this repo and confirm the tools list comes back
  • README detail page renders correctly on npmjs.com (no markdown breakage from the new table)

…r metadata

- LICENSE (MIT) so the published npm package and Smithery deployments
  ship with explicit license terms.
- AGENTS.md is the dedicated agent-facing playbook covering the hosted
  Streamable-HTTP endpoint at https://uapis.cn/mcp, npm/stdio install,
  per-agent wiring snippets (Claude / Cursor / etc.), tool overview,
  auth, rate-limits, and links to all UAPI discovery surfaces.
- smithery.yaml + Dockerfile so the server can be one-click deployed on
  smithery.ai via the published npm package.
- README.md gains an English summary block with badges (npm version,
  Node, MCP protocol version, license) and a wiring matrix; the
  existing 中文 documentation is preserved beneath the new section.
- package.json: human-readable English description, homepage now points
  to https://uapis.cn/mcp, license=MIT, plus npm-search-friendly
  keywords (mcp, model-context-protocol, uapi, public-api, ...).
- manifest.json: same keywords/description treatment so the manifest is
  consistent with package.json and surfaces well in MCP registries.

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@shuakami shuakami merged commit dd0f802 into main May 6, 2026
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.

2 participants