golf-mcp 0.2.17__tar.gz

golf_mcp-0.2.17/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2025] [Antoni Gmitruk]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

golf_mcp-0.2.17/MANIFEST.in

@@ -0,0 +1,38 @@
+include README.md
+include LICENSE
+include pyproject.toml
+graft .docs
+graft src/golf/examples
+
+# Exclude common Python bytecode files and caches
+prune **/__pycache__
+global-exclude *.py[co]
+
+# Exclude build artifacts and local env/dist files if they were accidentally included
+prune build
+prune dist
+prune .eggs
+prune *.egg-info
+prune .env
+prune .venv
+
+# Exclude development and cache directories
+prune .claude
+prune htmlcov
+prune thoughts
+prune new
+prune tests
+prune .pytest_cache
+prune .ruff_cache
+prune .git
+prune .github
+
+# Exclude development files
+exclude build.sh
+exclude setup.py
+exclude CLAUDE.md
+exclude Makefile
+exclude .coverage
+exclude .DS_Store
+exclude *.code-workspace
+exclude golf-banner.png 

golf_mcp-0.2.17/PKG-INFO

@@ -0,0 +1,262 @@
+Metadata-Version: 2.4
+Name: golf-mcp
+Version: 0.2.17
+Summary: Framework for building MCP servers
+Author-email: Antoni Gmitruk <antoni@golf.dev>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://golf.dev
+Project-URL: Repository, https://github.com/golf-mcp/golf
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer>=0.15.4
+Requires-Dist: rich>=14.0.0
+Requires-Dist: fastmcp==2.12.5
+Requires-Dist: pydantic>=2.11.0
+Requires-Dist: pydantic-settings>=2.0.0
+Requires-Dist: python-dotenv>=1.1.0
+Requires-Dist: black>=24.10.0
+Requires-Dist: pyjwt>=2.0.0
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: posthog>=4.1.0
+Requires-Dist: opentelemetry-api>=1.33.1
+Requires-Dist: opentelemetry-sdk>=1.33.1
+Requires-Dist: opentelemetry-instrumentation-asgi>=0.40b0
+Requires-Dist: opentelemetry-exporter-otlp-proto-http>=0.40b0
+Requires-Dist: wrapt>=1.17.0
+Provides-Extra: metrics
+Requires-Dist: prometheus-client>=0.22.1; extra == "metrics"
+Dynamic: license-file
+
+<div align="center">
+  <img src="./golf-banner.png" alt="Golf Banner">
+  
+  <br>
+  
+  <h1 align="center">
+    <br>
+    <span style="font-size: 80px;">⛳ Golf</span>
+    <br>
+  </h1>
+  
+  <h3 align="center">
+    Easiest framework for building MCP servers
+  </h3>
+  
+  <br>
+  
+  <p>
+    <a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="License"></a>
+    <a href="https://github.com/golf-mcp/golf/pulls"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs"></a>
+    <a href="https://github.com/golf-mcp/golf/issues"><img src="https://img.shields.io/badge/support-contact%20author-purple.svg" alt="Support"></a>
+  </p>
+  
+  <p>
+    <a href="https://docs.golf.dev"><strong>📚 Documentation</strong></a>
+  </p>
+</div>
+
+## Overview
+
+Golf is a **framework** designed to streamline the creation of MCP server applications. It allows developers to define server's capabilities—*tools*, *prompts*, and *resources*—as simple Python files within a conventional directory structure. Golf then automatically discovers, parses, and compiles these components into a runnable MCP server, minimizing boilerplate and accelerating development.
+
+With Golf v0.2.0, you get **enterprise-grade authentication** (JWT, OAuth Server, API key, development tokens), **built-in utilities** for LLM interactions, and **automatic telemetry** integration. Focus on implementing your agent's logic while Golf handles authentication, monitoring, and server infrastructure.
+
+## Quick Start
+
+Get your Golf project up and running in a few simple steps:
+
+### 1. Install Golf
+
+Ensure you have Python (3.10+ recommended) installed. Then, install Golf using pip:
+
+```bash
+pip install golf-mcp
+```
+
+### 2. Initialize Your Project
+
+Use the Golf CLI to scaffold a new project:
+
+```bash
+golf init your-project-name
+```
+This command creates a new directory (`your-project-name`) with a basic project structure, including example tools, resources, and a `golf.json` configuration file.
+
+### 3. Run the Development Server
+
+Navigate into your new project directory and start the development server:
+
+```bash
+cd your-project-name
+golf build dev
+golf run
+```
+This will start the MCP server, typically on `http://localhost:3000` (configurable in `golf.json`).
+
+That's it! Your Golf server is running and ready for integration.
+
+## Basic Project Structure
+
+A Golf project initialized with `golf init` will have a structure similar to this:
+
+```
+<your-project-name>/
+│
+├─ golf.json          # Main project configuration
+│
+├─ tools/             # Directory for tool implementations
+│   └─ hello.py       # Example tool
+│
+├─ resources/         # Directory for resource implementations
+│   └─ info.py        # Example resource
+│
+├─ prompts/           # Directory for prompt templates
+│   └─ welcome.py     # Example prompt
+│
+├─ .env               # Environment variables (e.g., API keys, server port)
+└─ auth.py            # Authentication configuration (JWT, OAuth Server, API key, dev tokens)
+```
+
+-   **`golf.json`**: Configures server name, port, transport, telemetry, and other build settings.
+-   **`auth.py`**: Dedicated authentication configuration file (new in v0.2.0, breaking change from v0.1.x authentication API) for JWT, OAuth Server, API key, or development authentication.
+-   **`tools/`**, **`resources/`**, **`prompts/`**: Contain your Python files, each defining a single component. These directories can also contain nested subdirectories to further organize your components (e.g., `tools/payments/charge.py`). The module docstring of each file serves as the component's description.
+    -   Component IDs are automatically derived from their file path. For example, `tools/hello.py` becomes `hello`, and a nested file like `tools/payments/submit.py` would become `submit_payments` (filename, followed by reversed parent directories under the main category, joined by underscores).
+
+## Example: Defining a Tool
+
+Creating a new tool is as simple as adding a Python file to the `tools/` directory. The example `tools/hello.py` in the boilerplate looks like this:
+
+```python
+# tools/hello.py
+"""Hello World tool {{project_name}}."""
+
+from typing import Annotated
+from pydantic import BaseModel, Field
+
+class Output(BaseModel):
+    """Response from the hello tool."""
+    message: str
+
+async def hello(
+    name: Annotated[str, Field(description="The name of the person to greet")] = "World",
+    greeting: Annotated[str, Field(description="The greeting phrase to use")] = "Hello"
+) -> Output:
+    """Say hello to the given name.
+    
+    This is a simple example tool that demonstrates the basic structure
+    of a tool implementation in Golf.
+    """
+    print(f"{greeting} {name}...")
+    return Output(message=f"{greeting}, {name}!")
+
+# Designate the entry point function
+export = hello
+```
+Golf will automatically discover this file. The module docstring `"""Hello World tool {{project_name}}."""` is used as the tool's description. It infers parameters from the `hello` function's signature and uses the `Output` Pydantic model for the output schema. The tool will be registered with the ID `hello`.
+
+## Authentication & Features
+
+Golf includes enterprise-grade authentication, built-in utilities, and automatic telemetry:
+
+```python
+# auth.py - Configure authentication
+from golf.auth import configure_auth, JWTAuthConfig, StaticTokenConfig, OAuthServerConfig
+
+# JWT authentication (production)
+configure_auth(JWTAuthConfig(
+    jwks_uri_env_var="JWKS_URI",
+    issuer_env_var="JWT_ISSUER", 
+    audience_env_var="JWT_AUDIENCE",
+    required_scopes=["read", "write"]
+))
+
+# OAuth Server mode (Golf acts as OAuth 2.0 server)
+# configure_auth(OAuthServerConfig(
+#     base_url="https://your-golf-server.com",
+#     valid_scopes=["read", "write", "admin"]
+# ))
+
+# Static tokens (development only)
+# configure_auth(StaticTokenConfig(
+#     tokens={"dev-token": {"client_id": "dev", "scopes": ["read"]}}
+# ))
+
+# Built-in utilities available in all tools
+from golf.utils import elicit, sample, get_context
+```
+
+```bash
+# Enable OpenTelemetry tracing
+export OTEL_TRACES_EXPORTER="otlp_http"
+export OTEL_EXPORTER_OTLP_ENDPOINT="http://localhost:4318/v1/traces"
+golf run  # ✅ Telemetry enabled
+```
+
+**[📚 Complete Documentation →](https://docs.golf.dev)**
+
+## Configuration
+
+Basic configuration in `golf.json`:
+
+```json
+{
+  "name": "My Golf Server",
+  "host": "localhost",
+  "port": 3000,
+  "transport": "sse",
+  "opentelemetry_enabled": false,
+  "detailed_tracing": false
+}
+```
+
+- **`transport`**: Choose `"sse"`, `"streamable-http"`, or `"stdio"`
+- **`opentelemetry_enabled`**: Enable OpenTelemetry tracing
+- **`detailed_tracing`**: Capture input/output (use carefully with sensitive data)
+
+
+## Privacy & Telemetry
+
+Golf collects **anonymous** usage data on the CLI to help us understand how the framework is being used and improve it over time. The data collected includes:
+
+- Commands run (init, build, run)
+- Success/failure status (no error details)
+- Golf version, Python version (major.minor only), and OS type
+- Template name (for init command only)
+- Build environment (dev/prod for build commands only)
+
+**No personal information, project names, code content, or error messages are ever collected.**
+
+### Opting Out
+
+You can disable telemetry in several ways:
+
+1. **Using the telemetry command** (recommended):
+   ```bash
+   golf telemetry disable
+   ```
+   This saves your preference permanently. To re-enable:
+   ```bash
+   golf telemetry enable
+   ```
+
+2. **During any command**: Add `--no-telemetry` to save your preference:
+   ```bash
+   golf init my-project --no-telemetry
+   ```
+
+Your telemetry preference is stored in `~/.golf/telemetry.json` and persists across all Golf commands.
+
+<div align="center">
+Made with ❤️ in Warsaw, Poland and SF
+</div>