@gopher.security/gopher-mcp-js 0.1.1

package/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 [yyyy] [name of copyright owner]
+
+   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.

package/README.md

@@ -0,0 +1,224 @@
+# @gopher.security/gopher-mcp-js
+
+TypeScript SDK for AI Agent orchestration with MCP (Model Context Protocol) support.
+
+[![npm version](https://img.shields.io/npm/v/@gopher.security/gopher-mcp-js.svg)](https://www.npmjs.com/package/@gopher.security/gopher-mcp-js)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+## Features
+
+- **Multi-Provider LLM Support** - Anthropic, OpenAI, Google, Azure, and more
+- **MCP Protocol** - Full Model Context Protocol client support
+- **Native Performance** - Powered by C++ core with TypeScript bindings
+- **Tool Orchestration** - Execute tools across multiple MCP servers
+- **Type Safety** - Full TypeScript support with strict mode
+
+## Supported LLM Providers
+
+| Provider | Models |
+|----------|--------|
+| Anthropic | Claude 3.5 Sonnet, Claude 3 Haiku, Claude 3 Opus |
+| OpenAI | GPT-4o, GPT-4o-mini, GPT-4 Turbo |
+| Google | Gemini 2.5 Flash, Gemini 2.0 Pro |
+| Azure OpenAI | GPT-4o, GPT-4 (via Azure deployment) |
+
+## Installation
+
+```bash
+npm install @gopher.security/gopher-mcp-js
+```
+
+The package automatically installs the correct native library for your platform:
+- macOS (ARM64, x64)
+- Linux (ARM64, x64)
+- Windows (ARM64, x64)
+
+## Quick Start
+
+### Using Gopher API Key (Recommended)
+
+```typescript
+import { GopherAgent } from '@gopher.security/gopher-mcp-js';
+
+// Create agent with Gopher API key (fetches MCP config automatically)
+const agent = GopherAgent.createWithApiKey(
+  'AnthropicProvider',
+  'claude-3-haiku-20240307',
+  process.env.GOPHER_API_KEY!
+);
+
+try {
+  const answer = agent.run('List all my Gmail drafts');
+  console.log(answer);
+} finally {
+  agent.dispose();
+}
+```
+
+### Using Custom Server Configuration
+
+```typescript
+import { GopherAgent } from '@gopher.security/gopher-mcp-js';
+
+const serverConfig = JSON.stringify({
+  succeeded: true,
+  code: 200000000,
+  message: 'success',
+  data: {
+    servers: [
+      {
+        version: '2025-01-09',
+        serverId: '1',
+        name: 'my-server',
+        transport: 'http_sse',
+        config: { url: 'http://localhost:3001/mcp', headers: {} },
+        connectTimeout: 5000,
+        requestTimeout: 30000,
+      },
+    ],
+  },
+});
+
+const agent = GopherAgent.createWithServerConfig(
+  'OpenAIProvider',
+  'gpt-4o-mini',
+  serverConfig
+);
+
+try {
+  const answer = agent.run('What tools are available?');
+  console.log(answer);
+} finally {
+  agent.dispose();
+}
+```
+
+### Using Configuration Builder
+
+```typescript
+import { GopherAgent, GopherAgentConfig } from '@gopher.security/gopher-mcp-js';
+
+const config = GopherAgentConfig.builder()
+  .provider('AnthropicProvider')
+  .model('claude-3-haiku-20240307')
+  .apiKey(process.env.GOPHER_API_KEY!)
+  .build();
+
+const agent = GopherAgent.create(config);
+
+try {
+  const answer = agent.run('Hello, what can you do?');
+  console.log(answer);
+} finally {
+  agent.dispose();
+}
+```
+
+## API Reference
+
+### GopherAgent
+
+```typescript
+// Create agent with Gopher API key
+GopherAgent.createWithApiKey(provider, model, apiKey): GopherAgent
+
+// Create agent with server configuration JSON
+GopherAgent.createWithServerConfig(provider, model, serverConfigJson): GopherAgent
+
+// Create agent with config object
+GopherAgent.create(config): GopherAgent
+
+// Run a query
+agent.run(query, timeoutMs?): string
+
+// Run with detailed result
+agent.runDetailed(query, timeoutMs?): AgentResult
+
+// Release resources (must be called when done)
+agent.dispose(): void
+```
+
+### Error Handling
+
+```typescript
+import {
+  GopherAgent,
+  AgentError,
+  ApiKeyError,
+  ConnectionError,
+  TimeoutError
+} from '@gopher.security/gopher-mcp-js';
+
+try {
+  const agent = GopherAgent.createWithApiKey(provider, model, apiKey);
+  const result = agent.run('query');
+  agent.dispose();
+} catch (e) {
+  if (e instanceof ApiKeyError) {
+    console.error('Invalid API key:', e.message);
+  } else if (e instanceof ConnectionError) {
+    console.error('Connection failed:', e.message);
+  } else if (e instanceof TimeoutError) {
+    console.error('Operation timed out:', e.message);
+  } else if (e instanceof AgentError) {
+    console.error('Agent error:', e.message);
+  }
+}
+```
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `GOPHER_API_KEY` | Your Gopher API key (get one at https://gopher.security) |
+| `ANTHROPIC_API_KEY` | Required when using AnthropicProvider |
+| `OPENAI_API_KEY` | Required when using OpenAIProvider |
+| `GOOGLE_API_KEY` | Required when using GoogleProvider |
+| `AZURE_OPENAI_API_KEY` | Required when using AzureProvider |
+| `GOPHER_DEBUG=1` | Enable debug logging |
+
+## Platform Packages
+
+The SDK uses platform-specific packages for native binaries:
+
+| Platform | Package |
+|----------|---------|
+| macOS ARM64 | `@gopher.security/gopher-orch-darwin-arm64` |
+| macOS x64 | `@gopher.security/gopher-orch-darwin-x64` |
+| Linux ARM64 | `@gopher.security/gopher-orch-linux-arm64` |
+| Linux x64 | `@gopher.security/gopher-orch-linux-x64` |
+| Windows ARM64 | `@gopher.security/gopher-orch-win32-arm64` |
+| Windows x64 | `@gopher.security/gopher-orch-win32-x64` |
+
+These are installed automatically as optional dependencies.
+
+## Requirements
+
+- Node.js 18+
+- Supported platforms: macOS, Linux, Windows (ARM64 or x64)
+
+## Troubleshooting
+
+### Native library not found
+
+If you see "Failed to load gopher-mcp native library":
+
+1. Ensure you're on a supported platform
+2. Try reinstalling: `npm install @gopher.security/gopher-mcp-js --force`
+3. Enable debug logging: `GOPHER_DEBUG=1 node your-app.js`
+
+### Permission errors on macOS
+
+```bash
+xattr -d com.apple.quarantine node_modules/@gopher.security/gopher-orch-darwin-*/lib/*.dylib
+```
+
+## Links
+
+- [GitHub Repository](https://github.com/GopherSecurity/gopher-mcp-js)
+- [Gopher Security](https://gopher.security)
+- [MCP Protocol Specification](https://modelcontextprotocol.io)
+
+## License
+
+Apache License 2.0 - See [LICENSE](LICENSE) for details.

package/dist/agent.d.ts

@@ -0,0 +1,118 @@
+/**
+ * GopherAgent - Main entry point for the gopher-orch TypeScript SDK.
+ *
+ * Provides a clean, TypeScript-friendly interface to the gopher-orch agent functionality.
+ *
+ * @example
+ * ```typescript
+ * // Create an agent with API key
+ * const agent = GopherAgent.create(
+ *   GopherAgentConfig.builder()
+ *     .provider('AnthropicProvider')
+ *     .model('claude-3-haiku-20240307')
+ *     .apiKey('your-api-key')
+ *     .build()
+ * );
+ *
+ * // Run a query
+ * const answer = agent.run('What time is it in Tokyo?');
+ * console.log(answer);
+ *
+ * // Cleanup
+ * agent.dispose();
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Use try-finally for automatic cleanup
+ * const agent = GopherAgent.create(config);
+ * try {
+ *   const answer = agent.run('What time is it in Tokyo?');
+ *   console.log(answer);
+ * } finally {
+ *   agent.dispose();
+ * }
+ * ```
+ */
+import { GopherAgentConfig } from './config';
+import { AgentResult } from './result';
+/**
+ * Main agent class for interacting with the gopher-orch native library.
+ */
+export declare class GopherAgent {
+    private handle;
+    private disposed;
+    private constructor();
+    /**
+     * Initialize the gopher-orch library.
+     *
+     * Must be called before creating any agents. Called automatically by create() if not already
+     * initialized.
+     *
+     * @throws {AgentError} if initialization fails
+     */
+    static init(): void;
+    /**
+     * Shutdown the gopher-orch library.
+     *
+     * Called automatically on process exit, but can be called manually.
+     */
+    static shutdown(): void;
+    /**
+     * Check if the library is initialized.
+     */
+    static isInitialized(): boolean;
+    /**
+     * Create a new GopherAgent instance.
+     *
+     * @param config Agent configuration
+     * @returns GopherAgent instance
+     * @throws {AgentError} if agent creation fails
+     */
+    static create(config: GopherAgentConfig): GopherAgent;
+    /**
+     * Create a new GopherAgent with API key.
+     *
+     * @param provider Provider name (e.g., "AnthropicProvider")
+     * @param model Model name (e.g., "claude-3-haiku-20240307")
+     * @param apiKey API key for fetching remote server config
+     * @returns GopherAgent instance
+     */
+    static createWithApiKey(provider: string, model: string, apiKey: string): GopherAgent;
+    /**
+     * Create a new GopherAgent with JSON server config.
+     *
+     * @param provider Provider name (e.g., "AnthropicProvider")
+     * @param model Model name (e.g., "claude-3-haiku-20240307")
+     * @param serverConfig JSON server configuration
+     * @returns GopherAgent instance
+     */
+    static createWithServerConfig(provider: string, model: string, serverConfig: string): GopherAgent;
+    /**
+     * Run a query against the agent.
+     *
+     * @param query The user query to process
+     * @param timeoutMs Timeout in milliseconds (default: 60000)
+     * @returns The agent's response
+     * @throws {AgentError} if the query fails
+     */
+    run(query: string, timeoutMs?: number): string;
+    /**
+     * Run a query with detailed result information.
+     *
+     * @param query The user query to process
+     * @param timeoutMs Timeout in milliseconds (default: 60000)
+     * @returns AgentResult with response and metadata
+     */
+    runDetailed(query: string, timeoutMs?: number): AgentResult;
+    /**
+     * Dispose of the agent and free resources.
+     */
+    dispose(): void;
+    /**
+     * Check if agent is disposed.
+     */
+    isDisposed(): boolean;
+    private ensureNotDisposed;
+}
+//# sourceMappingURL=agent.d.ts.map

package/dist/agent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"agent.d.ts","sourceRoot":"","sources":["../src/agent.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAqB,MAAM,UAAU,CAAC;AAO1D;;GAEG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,QAAQ,CAAS;IAEzB,OAAO;IAIP;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,IAAI,IAAI;IAcnB;;;;OAIG;IACH,MAAM,CAAC,QAAQ,IAAI,IAAI;IAIvB;;OAEG;IACH,MAAM,CAAC,aAAa,IAAI,OAAO;IAI/B;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,iBAAiB,GAAG,WAAW;IA0CrD;;;;;;;OAOG;IACH,MAAM,CAAC,gBAAgB,CACrB,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,GACb,WAAW;IAUd;;;;;;;OAOG;IACH,MAAM,CAAC,sBAAsB,CAC3B,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,EACb,YAAY,EAAE,MAAM,GACnB,WAAW;IAUd;;;;;;;OAOG;IACH,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,SAAQ,GAAG,MAAM;IAmB7C;;;;;;OAMG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,SAAQ,GAAG,WAAW;IAiB1D;;OAEG;IACH,OAAO,IAAI,IAAI;IAYf;;OAEG;IACH,UAAU,IAAI,OAAO;IAIrB,OAAO,CAAC,iBAAiB;CAK1B"}