Skip to content

fix: proper package entry point, missing pyproject modules, and updated install docs - #2

Open
chenqiaoanying wants to merge 1 commit into
splunk:mainfrom
chenqiaoanying:main
Open

fix: proper package entry point, missing pyproject modules, and updated install docs#2
chenqiaoanying wants to merge 1 commit into
splunk:mainfrom
chenqiaoanying:main

Conversation

@chenqiaoanying

@chenqiaoanying chenqiaoanying commented Apr 14, 2026

Copy link
Copy Markdown

Summary

  • Add proper package entry point — renamed internal async def main() to _main() and introduced a synchronous def main() as the [project.scripts] entry point so splunk-mcp-server works correctly when installed via pip or uv tool install
  • Fix pyproject.toml modules — added guardrails and spl_risk_rules to py-modules so they are included in the installed package
  • Fix FastMCP init param — changed description= to instructions= to match the current FastMCP API
  • Expand installation docs — rewrote the installation section to cover three methods (uv local clone, uvx one-shot, pip from GitHub) and updated Claude Desktop and Claude Code configuration examples to use the installed splunk-mcp-server command or uvx instead of python server.py
  • Add uv.lock — commit the lock file for reproducible installs

Test plan

  • uv tool install --editable . then run splunk-mcp-server — server starts without error
  • uvx --from "git+https://github.com/splunk/splunk-mcp-server2#subdirectory=python" splunk-mcp-server — runs directly without prior install
  • pip install "git+https://github.com/splunk/splunk-mcp-server2#subdirectory=python" then splunk-mcp-server — server starts without error
  • Verify guardrails and spl_risk_rules are importable after install
  • Claude Desktop stdio config using splunk-mcp-server command connects successfully

🤖 Generated with Claude Code

@chenqiaoanying chenqiaoanying changed the title Improve installation instructions and server initialization fix: proper package entry point, missing pyproject modules, and updated install docs Apr 14, 2026
@chenqiaoanying
chenqiaoanying marked this pull request as ready for review April 14, 2026 11:29
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