anomalyco/opencode
1
0
Fork 0
mirror of https://github.com/anomalyco/opencode.git synced 2026-07-21 17:56:33 -04:00
Code Issues 5.9k Packages Projects Releases 19 Wiki Activity

Support for using additional npm packages in custom tools #1816

New Issue
Closed
opened 2026-02-16 17:32:46 -05:00 by yindo · 12 comments
yindo commented 2026-02-16 17:32:46 -05:00
Owner
Copy Link
Copy Source

Originally created by @sigonzal3 on GitHub (Sep 24, 2025).

Originally assigned to: @thdxr on GitHub.

Environment

  • Installed as npm install opencode-ai --save-dev, using version 0.11.3
  • Node.js: v22.19.0
  • macOS: Tahoe 26.0

Issue
When creating custom tools, is it possible to use additional npm packages? I didn’t find any mention of this in the docs: https://opencode.ai/docs/custom-tools/

What I Tried

  • Added serialport to the main project package.json (devDependencies) → no effect
  • Added dependencies under .opencode/tool/ → caused Opencode to crash

Feature Request
It would be great if custom tools could use additional libraries without needing to build a separate MCP server.

Originally created by @sigonzal3 on GitHub (Sep 24, 2025). Originally assigned to: @thdxr on GitHub. **Environment** - Installed as `npm install opencode-ai --save-dev`, using version 0.11.3 - Node.js: v22.19.0 - macOS: Tahoe 26.0 **Issue** When creating custom tools, is it possible to use additional npm packages? I didn’t find any mention of this in the docs: https://opencode.ai/docs/custom-tools/ **What I Tried** - Added `serialport` to the main project `package.json` (`devDependencies`) → no effect - Added dependencies under `.opencode/tool/` → caused Opencode to crash **Feature Request** It would be great if custom tools could use additional libraries without needing to build a separate MCP server.
yindo closed this issue 2026-02-16 17:32:46 -05:00
yindo commented 2026-02-16 17:32:46 -05:00
Author
Owner
Copy Link
Copy Source

@rekram1-node commented on GitHub (Sep 25, 2025):

Yes it is possible

For example if I create a global tool: ~/.config/opencode/tool/test.ts:

import { tool } from "@opencode-ai/plugin";
import axios from "axios";

export default tool({
  description: "run when I ask you to run search query",
  args: {
    url: tool.schema.string(),
  },
  async execute(args) {
    return `Status code: ${await axios.get(args.url).then((res) => res.status)}`;
  },
});

I would create a package.json at ~/.config/opencode/package.json and install axios (not that i recommend using axios since fetch does what I need but I just figured it makes a good example)

@rekram1-node commented on GitHub (Sep 25, 2025): Yes it is possible For example if I create a global tool: ~/.config/opencode/tool/test.ts: ``` import { tool } from "@opencode-ai/plugin"; import axios from "axios"; export default tool({ description: "run when I ask you to run search query", args: { url: tool.schema.string(), }, async execute(args) { return `Status code: ${await axios.get(args.url).then((res) => res.status)}`; }, }); ``` I would create a package.json at ~/.config/opencode/package.json and install axios (not that i recommend using axios since fetch does what I need but I just figured it makes a good example)
yindo commented 2026-02-16 17:32:46 -05:00
Author
Owner
Copy Link
Copy Source

@sigonzal3 commented on GitHub (Sep 25, 2025):

Using ~/.config/opencode/tool/ won’t work for my use case. I want project-specific tools so they’re wired up automatically on clone, not configured globally.

I tried .opencode/tool/, but small mistakes there crashed opencode. Instead, I followed this guide to build a stdio MCP server in TypeScript, then pointed opencode.json to node .opencode/mcp/myscript.ts. It’s a bit heavier, but flexible—I can use any language/stack, keep complexity as needed, and avoid crashes since it runs as a separate process.

Request: Can you reserve .opencode/mcp/ and ~/.config/opencode/mcp/ for storing custom local MCP server code? No code changes needed—just update the docs and reserve the path to avoid future conflicts.

@sigonzal3 commented on GitHub (Sep 25, 2025): Using `~/.config/opencode/tool/` won’t work for my use case. I want project-specific tools so they’re wired up automatically on clone, not configured globally. I tried `.opencode/tool/`, but small mistakes there crashed opencode. Instead, I followed [this guide](https://github.com/modelcontextprotocol/typescript-sdk?tab=readme-ov-file#quick-start) to build a stdio MCP server in TypeScript, then pointed `opencode.json` to `node .opencode/mcp/myscript.ts`. It’s a bit heavier, but flexible—I can use any language/stack, keep complexity as needed, and avoid crashes since it runs as a separate process. **Request:** Can you reserve `.opencode/mcp/` and `~/.config/opencode/mcp/` for storing custom local MCP server code? No code changes needed—just update the docs and reserve the path to avoid future conflicts.
yindo commented 2026-02-16 17:32:46 -05:00
Author
Owner
Copy Link
Copy Source

@rekram1-node commented on GitHub (Sep 25, 2025):

@sigonzal3 this should work for any dir tho like in your project you could do:

mkdir -p .opencode/tool
cd .opencode/tool
bun init
bun i
< create your .ts or .js and import package >

And it should just work

you could also do the package.json in the .opencode/ dir

Image
@rekram1-node commented on GitHub (Sep 25, 2025): @sigonzal3 this should work for any dir tho like in your project you could do: mkdir -p .opencode/tool cd .opencode/tool bun init bun i <install package needed> < create your .ts or .js and import package > And it should just work you could also do the package.json in the .opencode/ dir <img width="231" height="241" alt="Image" src="https://github.com/user-attachments/assets/ef69bab6-3f24-4131-9aae-56e40a4eaab8" />
yindo commented 2026-02-16 17:32:46 -05:00
Author
Owner
Copy Link
Copy Source

@jfyne commented on GitHub (Sep 26, 2025):

With the new update today:

❯ opencode 
Error: Config file at [redacted]/.opencode is invalid: Unexpected directory "node_modules" found in "[redacted]/.opencode". Only agent, command, mode, plugin, tool directories are allowed.
@jfyne commented on GitHub (Sep 26, 2025): With the new update today: ``` ❯ opencode Error: Config file at [redacted]/.opencode is invalid: Unexpected directory "node_modules" found in "[redacted]/.opencode". Only agent, command, mode, plugin, tool directories are allowed. ```
yindo commented 2026-02-16 17:32:46 -05:00
Author
Owner
Copy Link
Copy Source

@jfyne commented on GitHub (Sep 26, 2025):

https://github.com/sst/opencode/commit/70310a37b323f1c55a73ed3391dd956f1e0ae0ce

This introduced the restriction, is there any more guidance as to do tools with dependencies?

@jfyne commented on GitHub (Sep 26, 2025): https://github.com/sst/opencode/commit/70310a37b323f1c55a73ed3391dd956f1e0ae0ce This introduced the restriction, is there any more guidance as to do tools with dependencies?
yindo commented 2026-02-16 17:32:46 -05:00
Author
Owner
Copy Link
Copy Source

@rekram1-node commented on GitHub (Sep 26, 2025):

@jfyne I think this was fixed on latest can you try again?

@rekram1-node commented on GitHub (Sep 26, 2025): @jfyne I think this was fixed on latest can you try again?
yindo commented 2026-02-16 17:32:47 -05:00
Author
Owner
Copy Link
Copy Source

@jfyne commented on GitHub (Sep 26, 2025):

Yup all good, thanks!

@jfyne commented on GitHub (Sep 26, 2025): Yup all good, thanks!
yindo commented 2026-02-16 17:32:47 -05:00
Author
Owner
Copy Link
Copy Source

@rekram1-node commented on GitHub (Sep 26, 2025):

Going to close since issues seem resolved and I provided guides above^^

Probably worth updating the docs too tho

@rekram1-node commented on GitHub (Sep 26, 2025): Going to close since issues seem resolved and I provided guides above^^ Probably worth updating the docs too tho
yindo commented 2026-02-16 17:32:47 -05:00
Author
Owner
Copy Link
Copy Source

@rekram1-node commented on GitHub (Sep 26, 2025):

also soon opencode will automatically resolve deps for u if u dont have package json

@rekram1-node commented on GitHub (Sep 26, 2025): also soon opencode will automatically resolve deps for u if u dont have package json
yindo commented 2026-02-16 17:32:47 -05:00
Author
Owner
Copy Link
Copy Source

@kierr commented on GitHub (Oct 9, 2025):

also soon opencode will automatically resolve deps for u if u dont have package json

I keep coming across quirks which, after lots of head scratching digging, end up being known issues. Would it be reasonable/viable to maintain some kind of SSoT of these "known issues" for users who aren't part of internal development?

If not, perhaps even just more strict "duplicate issue" closing, with the master issue labelled, would help everyone keep track of things?

@kierr commented on GitHub (Oct 9, 2025): > also soon opencode will automatically resolve deps for u if u dont have package json I keep coming across quirks which, after lots of head scratching digging, end up being known issues. Would it be reasonable/viable to maintain some kind of SSoT of these "known issues" for users who aren't part of internal development? If not, perhaps even just more strict "duplicate issue" closing, with the master issue labelled, would help everyone keep track of things?
yindo commented 2026-02-16 17:32:47 -05:00
Author
Owner
Copy Link
Copy Source

@rekram1-node commented on GitHub (Oct 9, 2025):

Yeah this will be easier once I start working on opencode full time and opentui version of opencode ships (since it will resolve a lot of open issues), there are soooo many issues and it can be difficult to parse through everything between github, discord, and x.

Totally makes sense. If you ever have any problems tho feel free to drop a message in our discord, you can dm me on any platform really and I will respond

@rekram1-node commented on GitHub (Oct 9, 2025): Yeah this will be easier once I start working on opencode full time and opentui version of opencode ships (since it will resolve a lot of open issues), there are soooo many issues and it can be difficult to parse through everything between github, discord, and x. Totally makes sense. If you ever have any problems tho feel free to drop a message in our discord, you can dm me on any platform really and I will respond
yindo commented 2026-02-16 17:32:47 -05:00
Author
Owner
Copy Link
Copy Source

@kierr commented on GitHub (Oct 9, 2025):

Yeah this will be easier once I start working on opencode full time and opentui version of opencode ships (since it will resolve a lot of open issues), there are soooo many issues and it can be difficult to parse through everything between github, discord, and x.

Totally makes sense. If you ever have any problems tho feel free to drop a message in our discord, you can dm me on any platform really and I will respond

Thanks! Coincidentally I DMed you on Discord before seeing this.

@kierr commented on GitHub (Oct 9, 2025): > Yeah this will be easier once I start working on opencode full time and opentui version of opencode ships (since it will resolve a lot of open issues), there are soooo many issues and it can be difficult to parse through everything between github, discord, and x. > > Totally makes sense. If you ever have any problems tho feel free to drop a message in our discord, you can dm me on any platform really and I will respond Thanks! Coincidentally I DMed you on Discord before seeing this.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
acp
bad
bug
discussion
docs
documentation
enhancement
extension
good first issue
growth
help-wanted
mcp
model-problem
needs:compliance
nix
opentui
perf
pull-request
Mirrored from GitHub Pull Request
 tui
web
windows
zen
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: anomalyco/opencode#1816
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?